public class DataSetParameter
extends org.eclipse.birt.report.model.core.PropertyStructure
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ALLOW_NULL_MEMBER
Name of the member indicating that whether the value of this parameter
can be
null . |
static java.lang.String |
DATA_TYPE_MEMBER
Name of the parameter data type member.
|
static java.lang.String |
DEFAULT_VALUE_MEMBER
Name of the parameter default value member.
|
static java.lang.String |
DESCRIPTION_ID_MEMBER
Name of the member indicating the description id of the parameter
|
static java.lang.String |
DESCRIPTION_MEMBER
Name of the member indicating the description of the parameter
|
static java.lang.String |
DISPLAY_NAME_ID_MEMBER
Name of the member indicating the display name id of the parameter
|
static java.lang.String |
DISPLAY_NAME_MEMBER
Name of the member indicating the display name of the parameter
|
static java.lang.String |
HEADING_ID_MEMBER
Name of the member indicating the heading id of the parameter
|
static java.lang.String |
HEADING_MEMBER
Name of the member indicating the heading of the parameter
|
static java.lang.String |
HELP_TEXT_ID_MEMBER
Name of the member indicating the help text id of the parameter
|
static java.lang.String |
HELP_TEXT_MEMBER
Name of the member indicating the help text of the parameter
|
static java.lang.String |
IS_INPUT_MEMBER
Name of the member indicating that whether this is an input parameter.
|
static java.lang.String |
IS_NULLABLE_MEMBER
Deprecated.
|
static java.lang.String |
IS_OPTIONAL_MEMBER
Name of the member indicating that whether the report must provide a
value for this parameter.
|
static java.lang.String |
IS_OUTPUT_MEMBER
Name of the member indicating that whether this is an output parameter.
|
static java.lang.String |
NAME_MEMBER
Name of the parameter name member.
|
static java.lang.String |
NATIVE_DATA_TYPE_MEMBER
Name of the member indicating the native (database) data type code.
|
static java.lang.String |
POSITION_MEMBER
Name of the position member.
|
static java.lang.String |
STRUCT_NAME
Name of this structure.
|
Constructor and Description |
---|
DataSetParameter() |
Modifier and Type | Method and Description |
---|---|
boolean |
allowNull()
Checks whether the value of this parameter can be
null . |
java.lang.String |
getDataType()
Returns the parameter data type.
|
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.
|
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.
|
java.lang.String |
getStructName()
Returns the name of the structure definition.
|
StructureHandle |
handle(SimpleValueHandle valueHandle,
int index)
Creates the specific handle of this structure.
|
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 parameter data type.
|
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 |
setDescriptionKey(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 id 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.
|
java.util.List |
validate(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Validate whether this structure is valid.
|
clone, getIntrinsicProperty, getLocalProperty, getLocalProperty, setIntrinsicProperty, setProperty
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setupContext, updateReference
public static final java.lang.String STRUCT_NAME
public static final java.lang.String POSITION_MEMBER
public static final java.lang.String NAME_MEMBER
public static final java.lang.String DATA_TYPE_MEMBER
public static final java.lang.String IS_OPTIONAL_MEMBER
public static final java.lang.String DEFAULT_VALUE_MEMBER
public static final java.lang.String IS_NULLABLE_MEMBER
null
.public static final java.lang.String ALLOW_NULL_MEMBER
null
.public static final java.lang.String IS_INPUT_MEMBER
public static final java.lang.String IS_OUTPUT_MEMBER
public static final java.lang.String NATIVE_DATA_TYPE_MEMBER
public static final java.lang.String DISPLAY_NAME_MEMBER
public static final java.lang.String DISPLAY_NAME_ID_MEMBER
public static final java.lang.String HEADING_MEMBER
public static final java.lang.String HEADING_ID_MEMBER
public static final java.lang.String HELP_TEXT_MEMBER
public static final java.lang.String HELP_TEXT_ID_MEMBER
public static final java.lang.String DESCRIPTION_MEMBER
public static final java.lang.String DESCRIPTION_ID_MEMBER
public java.lang.String getStructName()
IStructure
public 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 java.lang.String getDataType()
public void setDataType(java.lang.String dataType)
dataType
- the data type to setpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- the name to setpublic java.lang.Integer getPosition()
public void setPosition(java.lang.Integer position)
position
- the position to setpublic StructureHandle handle(SimpleValueHandle valueHandle, int index)
org.eclipse.birt.report.model.core.Structure
handle
in class org.eclipse.birt.report.model.core.Structure
valueHandle
- the value handle of this structure list property this
structure is inindex
- the position of this structure in structure listpublic java.util.List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
org.eclipse.birt.report.model.core.Structure
PropertyValueException
.validate
in class org.eclipse.birt.report.model.core.Structure
module
- the moduleelement
- the element contains this structurepublic 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)
dataType
- the data type to setSemanticException
- 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 headingpublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the new description of this parameterpublic java.lang.String getDescriptionKey()
public void setDescriptionKey(java.lang.String descriptionID)
descriptionID
- the new resource key of the descriptionCopyright © 2008 Actuate Corp. All rights reserved.