org.eclipse.birt.report.model.api
Class OdaDataSetParameterHandle

java.lang.Object
  extended by org.eclipse.birt.report.model.api.ElementDetailHandle
      extended by org.eclipse.birt.report.model.api.ValueHandle
          extended by org.eclipse.birt.report.model.api.StructureHandle
              extended by org.eclipse.birt.report.model.api.DataSetParameterHandle
                  extended by org.eclipse.birt.report.model.api.OdaDataSetParameterHandle

public class OdaDataSetParameterHandle
extends DataSetParameterHandle

Represents the parameter for ODA drivers. The parameter is the part of the data set definition, if defined. A parameter can be an input or output parameter. A parameter can also be input and output parameter. Each data set parameter has the following properties:

Native Name
The name known to an ODA custom designer and runtime driver.
Parameter Name
An optionally linked report parameter name.
Native Data Type
Data type defined in the data set driver.


Field Summary
 
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structRef
 
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
 
Constructor Summary
OdaDataSetParameterHandle(SimpleValueHandle valueHandle, int index)
          Constructs the handle of oda data set parameter.
 
Method Summary
 java.lang.Integer getNativeDataType()
          Returns the native data type.
 java.lang.String getNativeName()
          Returns the native name of this oda dataset parameter.
 java.lang.String getParamName()
          Returns the name of the report parameter which is referenced by this oda dataset parameter.
 void setNativeDataType(java.lang.Integer dataType)
          Sets the parameter native data type.
 void setNativeName(java.lang.String nativeName)
          Sets the native name for this oda dataset parameter.
 void setParamName(java.lang.String name)
          Sets the report parameter name which refered by this oda dataset parameter.
 
Methods inherited from class org.eclipse.birt.report.model.api.DataSetParameterHandle
allowNull, getDataType, getDefaultValue, getMember, getName, getParameterDataType, getPosition, isInput, isNullable, isOptional, isOutput, setAllowNull, setDataType, setDefaultValue, setIsInput, setIsNullable, setIsOptional, setIsOutput, setName, setParameterDataType, setPosition
 
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getDefn, getExternalizedValue, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently
 
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OdaDataSetParameterHandle

public OdaDataSetParameterHandle(SimpleValueHandle valueHandle,
                                 int index)
Constructs the handle of oda data set parameter.

Parameters:
valueHandle - the value handle for oda data set parameter list of one property
index - the position of this oda data set parameter in the list
Method Detail

setParamName

public void setParamName(java.lang.String name)
Sets the report parameter name which refered by this oda dataset parameter.

Parameters:
name - report parameter name.

setNativeName

public void setNativeName(java.lang.String nativeName)
Sets the native name for this oda dataset parameter.

Parameters:
nativeName - native name

getParamName

public java.lang.String getParamName()
Returns the name of the report parameter which is referenced by this oda dataset parameter. Null if there is no report parameter referenced.

Returns:
report parameter name.

getNativeName

public java.lang.String getNativeName()
Returns the native name of this oda dataset parameter.

Returns:
the native name

getNativeDataType

public java.lang.Integer getNativeDataType()
Returns the native data type.

Overrides:
getNativeDataType in class DataSetParameterHandle
Returns:
the parameter native data type.

setNativeDataType

public void setNativeDataType(java.lang.Integer dataType)
Sets the parameter native data type.

Overrides:
setNativeDataType in class DataSetParameterHandle
Parameters:
dataType - the native data type to set.


Copyright © 2008 Actuate Corp. All rights reserved.