Class OdaDataSetParameter
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.PropertyStructure
org.eclipse.birt.report.model.api.elements.structures.DataSetParameter
org.eclipse.birt.report.model.api.elements.structures.OdaDataSetParameter
- All Implemented Interfaces:
Cloneable,IStructure,org.eclipse.birt.report.model.core.IPropertySet
Represents the parameter for ODA drivers.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringName of the member indicating the native (database) data type code.static final StringThe native name from oda parameter.static final StringThe parameter name used to refer to a report parameter.static final StringName of this structure.Fields inherited from class org.eclipse.birt.report.model.api.elements.structures.DataSetParameter
ALLOW_NULL_MEMBER, DATA_TYPE_MEMBER, DEFAULT_VALUE_MEMBER, DESCRIPTION_ID_MEMBER, DESCRIPTION_MEMBER, DISPLAY_NAME_ID_MEMBER, DISPLAY_NAME_MEMBER, HEADING_ID_MEMBER, HEADING_MEMBER, HELP_TEXT_ID_MEMBER, HELP_TEXT_MEMBER, IS_INPUT_MEMBER, IS_NULLABLE_MEMBER, IS_OPTIONAL_MEMBER, IS_OUTPUT_MEMBER, NAME_MEMBER, POSITION_MEMBERFields inherited from class org.eclipse.birt.report.model.core.PropertyStructure
propValues -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected ObjectgetIntrinsicProperty(String propName) Returns the value of a structure property represented as a member variable.Returns the native data type.returns the native parameter name.returns the report parameter name.Returns the name of the structure definition.handle(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.protected voidsetIntrinsicProperty(String propName, Object value) Sets the value of of a structure property represented as a member variable.voidsetNativeDataType(Integer dataType) Sets the parameter native data type.voidsetNativeName(String name) set the native oda dataset parameter name.voidsetParamName(String name) set the refered report parameter name.Methods inherited from class org.eclipse.birt.report.model.api.elements.structures.DataSetParameter
allowNull, getDataType, getDefaultValue, getDescription, getDescriptionKey, getDisplayName, getDisplayNameKey, getHeading, getHeadingKey, getHelpText, getHelpTextKey, getName, getParameterDataType, getPosition, isInput, isNullable, isOptional, isOutput, setAllowNull, setDataType, setDefaultValue, setDescription, setDescriptionKey, setDisplayName, setDisplayNameKey, setHeading, setHeadingKey, setHelpText, setHelpTextKey, setIsInput, setIsNullable, setIsOptional, setIsOutput, setName, setParameterDataType, setPosition, validateMethods inherited from class org.eclipse.birt.report.model.core.PropertyStructure
clone, getLocalProperty, getLocalProperty, setPropertyMethods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setupContext, updateReference
-
Field Details
-
STRUCT_NAME
Name of this structure. Matches the definition in the meta-data dictionary.- See Also:
-
PARAM_NAME_MEMBER
The parameter name used to refer to a report parameter.- See Also:
-
NATIVE_NAME_MEMBER
The native name from oda parameter.- See Also:
-
NATIVE_DATA_TYPE_MEMBER
Name of the member indicating the native (database) data type code.- See Also:
-
-
Constructor Details
-
OdaDataSetParameter
public OdaDataSetParameter()
-
-
Method Details
-
handle
Description copied from class:org.eclipse.birt.report.model.core.StructureCreates the specific handle of this structure. This handle is always created.- Overrides:
handlein classDataSetParameter- Parameters:
valueHandle- the value handle of this structure list property this structure is inindex- the position of this structure in structure list- Returns:
- the handle of this structure.
-
getIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.StructureReturns the value of a structure property represented as a member variable.- Overrides:
getIntrinsicPropertyin classorg.eclipse.birt.report.model.core.PropertyStructure- Parameters:
propName- name of the property- Returns:
- the value of the property, or null if the property is not set
-
setIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.StructureSets the value of of a structure property represented as a member variable.- Overrides:
setIntrinsicPropertyin classorg.eclipse.birt.report.model.core.PropertyStructure- Parameters:
propName- the name of the property to setvalue- the property value
-
setParamName
set the refered report parameter name.- Parameters:
name- the parameter name
-
setNativeName
set the native oda dataset parameter name.- Parameters:
name- the native name
-
getParamName
returns the report parameter name.- Returns:
- report parameter name
-
getNativeName
returns the native parameter name.- Returns:
- native parameter name
-
getStructName
Description copied from interface:IStructureReturns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.- Specified by:
getStructNamein interfaceIStructure- Overrides:
getStructNamein classDataSetParameter- Returns:
- the internal name of the structure a defined in the meta-data dictionary.
-
getNativeDataType
Returns the native data type.- Overrides:
getNativeDataTypein classDataSetParameter- Returns:
- the parameter native data type.
-
setNativeDataType
Sets the parameter native data type.- Overrides:
setNativeDataTypein classDataSetParameter- Parameters:
dataType- the native data type to set.
-