|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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
public class DataSetParameterHandle
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:
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
structContext |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
DataSetParameterHandle(SimpleValueHandle valueHandle,
int index)
Constructs the handle of data set parameter. |
Method Summary | |
---|---|
boolean |
allowNull()
Checks whether the value of this parameter can be null . |
java.lang.String |
getDataType()
Returns the data type of this parameter. |
java.lang.String |
getDefaultValue()
Gets the default value of the input parameter. |
java.lang.String |
getDescription()
Gets the description of this parameter. |
java.lang.String |
getDescriptionKey()
Gets the resource key of the description of this parameter. |
java.lang.String |
getDisplayName()
Gets the display name of this parameter. |
java.lang.String |
getDisplayNameKey()
Gets the resource key of the display name of this parameter. |
java.lang.String |
getHeading()
Gets the heading of this parameter. |
java.lang.String |
getHeadingKey()
Gets the resource key of the heading of this parameter. |
java.lang.String |
getHelpText()
Gets the help text of this parameter. |
java.lang.String |
getHelpTextKey()
Gets the resource key of the help text of this parameter. |
MemberHandle |
getMember(java.lang.String memberName)
Returns a handle to a structure member. |
java.lang.String |
getName()
Returns the parameter name. |
java.lang.Integer |
getNativeDataType()
Returns the native data type. |
java.lang.String |
getParameterDataType()
Returns the data type in parameter type choices of this parameter. |
java.lang.Integer |
getPosition()
Returns the position of this parameter in parameter list. |
boolean |
isInput()
Checks whether this parameter is an input parameter. |
boolean |
isNullable()
Deprecated. Use allowNull() |
boolean |
isOptional()
Whether the parameter is optional. |
boolean |
isOutput()
Checks whether this parameter is an output parameter. |
void |
setAllowNull(boolean allowNull)
Sets whether the value of this parameter can be null . |
void |
setDataType(java.lang.String dataType)
Sets the data type of this parameter. |
void |
setDefaultValue(java.lang.String expr)
Sets the default value of the input parameter. |
void |
setDescription(java.lang.String description)
Sets the description of this parameter. |
void |
setDescriptoinKey(java.lang.String descriptionID)
Sets the resource key of the description of this parameter. |
void |
setDisplayName(java.lang.String displayName)
Sets the display name of this parameter. |
void |
setDisplayNameKey(java.lang.String displayNameID)
Sets the resource key of the display name of this parameter. |
void |
setHeading(java.lang.String heading)
Sets the heading of this parameter. |
void |
setHeadingKey(java.lang.String headingID)
Sets the resource key of the heading of this parameter. |
void |
setHelpText(java.lang.String helpText)
Sets the help text of this parameter. |
void |
setHelpTextKey(java.lang.String helpTextID)
Sets the resource key of the help text of this parameter. |
void |
setIsInput(boolean isInput)
Sets whether this parameter is an input parameter. |
void |
setIsNullable(boolean isNullable)
Deprecated. Use setAllowNull(boolean) |
void |
setIsOptional(boolean value)
Sets whether the parameter is optional. |
void |
setIsOutput(boolean isOutput)
Sets whether this parameter is an output parameter. |
void |
setName(java.lang.String name)
Sets the parameter name. |
void |
setNativeDataType(java.lang.Integer dataType)
Sets the parameter native data type. |
void |
setParameterDataType(java.lang.String dataType)
Sets the data type in parameter type choices to this parameter. |
void |
setPosition(java.lang.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, setPropertySilently |
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle |
---|
getReference |
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 |
---|
public DataSetParameterHandle(SimpleValueHandle valueHandle, int index)
valueHandle
- the value handle for data set parameter list of one propertyindex
- the position of this data set parameter in the listMethod Detail |
---|
public java.lang.String getDataType()
public void setDataType(java.lang.String dataType) throws SemanticException
dataType
- the data type to set
SemanticException
- if the value is not in the above list.public java.lang.String getName()
public void setName(java.lang.String name) throws SemanticException
name
- the name to set
SemanticException
- value required exceptionpublic java.lang.Integer getPosition()
public void setPosition(java.lang.Integer position)
position
- the position to setpublic boolean isOptional()
public void setIsOptional(boolean value)
value
- the value to setpublic void setDefaultValue(java.lang.String expr)
expr
- the default valuepublic java.lang.String getDefaultValue()
public boolean isInput()
true
if it is an input parameter. Otherwise
false
.public void setIsInput(boolean isInput)
isInput
- true
if it is an input parameter. Otherwise
false
.public boolean isNullable()
allowNull()
null
.
true
if the value can be null
.
Otherwise false
.public void setIsNullable(boolean isNullable)
setAllowNull(boolean)
null
.
isNullable
- true
if the value can be null
.
Otherwise false
.public boolean allowNull()
null
.
true
if the value can be null
.
Otherwise false
.public void setAllowNull(boolean allowNull)
null
.
allowNull
- true
if the value can be null
.
Otherwise false
.public boolean isOutput()
true
if it is an output parameter. Otherwise
false
.public void setIsOutput(boolean isOutput)
isOutput
- true
if it is an output parameter. Otherwise
false
.public MemberHandle getMember(java.lang.String memberName)
StructureHandle
getMember
in class StructureHandle
memberName
- the name of the member
null
if the member is not
defined on the structure.public java.lang.Integer getNativeDataType()
public void setNativeDataType(java.lang.Integer dataType)
dataType
- the native data type to set.public java.lang.String getParameterDataType()
public void setParameterDataType(java.lang.String dataType) throws SemanticException
dataType
- the data type to set
SemanticException
- if the value is not in the above list.public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String displayName)
displayName
- the new display name of this parameterpublic java.lang.String getDisplayNameKey()
public void setDisplayNameKey(java.lang.String displayNameID)
displayNameID
- the new resource key of the display namepublic java.lang.String getHeading()
public void setHeading(java.lang.String heading)
heading
- the new heading of this parameterpublic java.lang.String getHeadingKey()
public void setHeadingKey(java.lang.String headingID)
headingID
- the new resource key of the headingpublic java.lang.String getHelpText()
public void setHelpText(java.lang.String helpText)
helpText
- the new help text of this parameterpublic java.lang.String getHelpTextKey()
public void setHelpTextKey(java.lang.String helpTextID)
helpTextID
- the new resource key of the help textpublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the new description of this parameterpublic java.lang.String getDescriptionKey()
public void setDescriptoinKey(java.lang.String descriptionID)
descriptionID
- the new resource key of the description
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |