Class DataSetParameterHandle
java.lang.Object
org.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.DataSetParameterHandle
- Direct Known Subclasses:
OdaDataSetParameterHandle
Represents the parameter for data set 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:
- Name
- a data set parameter has a required name.
- Position
- a data set parameter has an optional position for it.
- Data Type
- a data set parameter has a choice data type: any, integer, string, data time, decimal, float, structure or table.
- Is optional
- whether this parameter is optional.
- Is Nullable
- whether the value of this parameter can be nullable.
- Is Input
- whether this parameter is an input parameter.
- Is Output
- whether this parameter is an output parameter.
-
Field Summary
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContextFields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle -
Constructor Summary
ConstructorsConstructorDescriptionDataSetParameterHandle(SimpleValueHandle valueHandle, int index) Constructs the handle of data set parameter. -
Method Summary
Modifier and TypeMethodDescriptionbooleanChecks whether the value of this parameter can benull.Returns the data type of this parameter.Gets the default value of the input parameter.Gets the description of this parameter.Gets the resource key of the description of this parameter.Gets the display name of this parameter.Gets the resource key of the display name of this parameter.Gets the heading of this parameter.Gets the resource key of the heading of this parameter.Gets the help text of this parameter.Gets the resource key of the help text of this parameter.Returns a handle to a structure member.getName()Returns the parameter name.Returns the native data type.Returns the data type in parameter type choices of this parameter.Returns the position of this parameter in parameter list.booleanisInput()Checks whether this parameter is an input parameter.booleanDeprecated.booleanWhether the parameter is optional.booleanisOutput()Checks whether this parameter is an output parameter.voidsetAllowNull(boolean allowNull) Sets whether the value of this parameter can benull.voidsetDataType(String dataType) Sets the data type of this parameter.voidsetDefaultValue(String expr) Sets the default value of the input parameter.voidsetDescription(String description) Sets the description of this parameter.voidsetDescriptoinKey(String descriptionID) Sets the resource key of the description of this parameter.voidsetDisplayName(String displayName) Sets the display name of this parameter.voidsetDisplayNameKey(String displayNameID) Sets the resource key of the display name of this parameter.voidsetHeading(String heading) Sets the heading of this parameter.voidsetHeadingKey(String headingID) Sets the resource key of the heading of this parameter.voidsetHelpText(String helpText) Sets the help text of this parameter.voidsetHelpTextKey(String helpTextID) Sets the resource key of the help text of this parameter.voidsetIsInput(boolean isInput) Sets whether this parameter is an input parameter.voidsetIsNullable(boolean isNullable) Deprecated.UsesetAllowNull(boolean)voidsetIsOptional(boolean value) Sets whether the parameter is optional.voidsetIsOutput(boolean isOutput) Sets whether this parameter is an output parameter.voidSets the parameter name.voidsetNativeDataType(Integer dataType) Sets the parameter native data type.voidsetParameterDataType(String dataType) Sets the data type in parameter type choices to this parameter.voidsetPosition(Integer position) Sets the position of this parameter in parameter list.Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilentlyMethods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReferenceMethods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
Constructor Details
-
DataSetParameterHandle
Constructs the handle of data set parameter.- Parameters:
valueHandle- the value handle for data set parameter list of one propertyindex- the position of this data set parameter in the list
-
-
Method Details
-
getDataType
Returns the data type of this parameter. The possible values are:- COLUMN_DATA_TYPE_ANY
- COLUMN_DATA_TYPE_INTEGER
- COLUMN_DATA_TYPE_STRING
- COLUMN_DATA_TYPE_DATETIME
- COLUMN_DATA_TYPE_DECIMAL
- COLUMN_DATA_TYPE_FLOAT
- COLUMN_DATA_TYPE_STRUCTURE
- COLUMN_DATA_TYPE_TABLE
- Returns:
- the data type of this parameter.
-
setDataType
Sets the data type of this parameter. The allowed values are:- COLUMN_DATA_TYPE_ANY
- COLUMN_DATA_TYPE_INTEGER
- COLUMN_DATA_TYPE_STRING
- COLUMN_DATA_TYPE_DATETIME
- COLUMN_DATA_TYPE_DECIMAL
- COLUMN_DATA_TYPE_FLOAT
- COLUMN_DATA_TYPE_STRUCTURE
- COLUMN_DATA_TYPE_TABLE
- Parameters:
dataType- the data type to set- Throws:
SemanticException- if the value is not in the above list.
-
getName
Returns the parameter name.- Returns:
- the parameter name
-
setName
Sets the parameter name.- Parameters:
name- the name to set- Throws:
SemanticException- value required exception
-
getPosition
Returns the position of this parameter in parameter list.- Returns:
- the position of this parameter.
-
setPosition
Sets the position of this parameter in parameter list.- Parameters:
position- the position to set
-
isOptional
public boolean isOptional()Whether the parameter is optional.- Returns:
- whether the parameter is optional
-
setIsOptional
public void setIsOptional(boolean value) Sets whether the parameter is optional.- Parameters:
value- the value to set
-
setDefaultValue
Sets the default value of the input parameter.- Parameters:
expr- the default value
-
getDefaultValue
Gets the default value of the input parameter.- Returns:
- the default value
-
isInput
public boolean isInput()Checks whether this parameter is an input parameter.- Returns:
trueif it is an input parameter. Otherwisefalse.
-
setIsInput
public void setIsInput(boolean isInput) Sets whether this parameter is an input parameter.- Parameters:
isInput-trueif it is an input parameter. Otherwisefalse.
-
isNullable
Deprecated.UseallowNull()Checks whether the value of this parameter can benull.- Returns:
trueif the value can benull. Otherwisefalse.
-
setIsNullable
Deprecated.UsesetAllowNull(boolean)Sets whether the value of this parameter can benull.- Parameters:
isNullable-trueif the value can benull. Otherwisefalse.
-
allowNull
public boolean allowNull()Checks whether the value of this parameter can benull.- Returns:
trueif the value can benull. Otherwisefalse.
-
setAllowNull
public void setAllowNull(boolean allowNull) Sets whether the value of this parameter can benull.- Parameters:
allowNull-trueif the value can benull. Otherwisefalse.
-
isOutput
public boolean isOutput()Checks whether this parameter is an output parameter.- Returns:
trueif it is an output parameter. Otherwisefalse.
-
setIsOutput
public void setIsOutput(boolean isOutput) Sets whether this parameter is an output parameter.- Parameters:
isOutput-trueif it is an output parameter. Otherwisefalse.
-
getMember
Description copied from class:StructureHandleReturns a handle to a structure member.- Overrides:
getMemberin classStructureHandle- Parameters:
memberName- the name of the member- Returns:
- a handle to the member or
nullif the member is not defined on the structure.
-
getNativeDataType
Returns the native data type.- Returns:
- the parameter native data type.
-
setNativeDataType
Sets the parameter native data type.- Parameters:
dataType- the native data type to set.
-
getParameterDataType
Returns the data type in parameter type choices of this parameter. The possible values are:- PARAM_TYPE_ANY
- PARAM_TYPE_INTEGER
- PARAM_TYPE_STRING
- PARAM_TYPE_DATETIME
- PARAM_TYPE_DECIMAL
- PARAM_TYPE_FLOAT
- PARAM_TYPE_BOOLEAN
- Returns:
- the data type of this parameter.
-
setParameterDataType
Sets the data type in parameter type choices to this parameter. The allowed values are:- PARAM_TYPE_ANY
- PARAM_TYPE_INTEGER
- PARAM_TYPE_STRING
- PARAM_TYPE_DATETIME
- PARAM_TYPE_DECIMAL
- PARAM_TYPE_FLOAT
- PARAM_TYPE_BOOLEAN
- Parameters:
dataType- the data type to set- Throws:
SemanticException- if the value is not in the above list.
-
getDisplayName
Gets the display name of this parameter.- Returns:
- the display name of this parameter
-
setDisplayName
Sets the display name of this parameter.- Parameters:
displayName- the new display name of this parameter
-
getDisplayNameKey
Gets the resource key of the display name of this parameter.- Returns:
- the resource key of the display name
-
setDisplayNameKey
Sets the resource key of the display name of this parameter.- Parameters:
displayNameID- the new resource key of the display name
-
getHeading
Gets the heading of this parameter.- Returns:
- the heading of this parameter
-
setHeading
Sets the heading of this parameter.- Parameters:
heading- the new heading of this parameter
-
getHeadingKey
Gets the resource key of the heading of this parameter.- Returns:
- the resource key of the heading
-
setHeadingKey
Sets the resource key of the heading of this parameter.- Parameters:
headingID- the new resource key of the heading
-
getHelpText
Gets the help text of this parameter.- Returns:
- the help text of this parameter
-
setHelpText
Sets the help text of this parameter.- Parameters:
helpText- the new help text of this parameter
-
getHelpTextKey
Gets the resource key of the help text of this parameter.- Returns:
- the resource key of the help text
-
setHelpTextKey
Sets the resource key of the help text of this parameter.- Parameters:
helpTextID- the new resource key of the help text
-
getDescription
Gets the description of this parameter.- Returns:
- the description of this parameter
-
setDescription
Sets the description of this parameter.- Parameters:
description- the new description of this parameter
-
getDescriptionKey
Gets the resource key of the description of this parameter.- Returns:
- the resource key of the description
-
setDescriptoinKey
Sets the resource key of the description of this parameter.- Parameters:
descriptionID- the new resource key of the description
-
allowNull()