Class ResultSetColumn
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.api.elements.structures.ResultSetColumn
- All Implemented Interfaces:
Cloneable,IStructure,org.eclipse.birt.report.model.core.IPropertySet
- Direct Known Subclasses:
OdaResultSetColumn
public class ResultSetColumn
extends org.eclipse.birt.report.model.core.Structure
This class represents one column in the result set.
This is a managed object, meaning that all changes should be made though the command layer so that they can be undone and redone. Each result set column has the following properties:
- Name
- a result set column has an optional name.
- Position
- a result set column has an optional position for it.
- Data Type
- a result set column has a choice data type: any, integer, string, data time, decimal, float, structure or table.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringName of the data type member.static final StringName of the column name member.static final StringName of the member indicating the native (database) data type code.static final StringName of the position member.static final StringName of this structure. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the column name.Returns the data type of this column.protected ObjectgetIntrinsicProperty(String propName) Returns the value of a structure property represented as a member variable.Returns the native data type.Returns the position of this parameter.Returns the name of the structure definition.handle(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.voidsetColumnName(String columnName) Sets the column name.voidsetDataType(String dataType) Sets the data type of this column.protected voidsetIntrinsicProperty(String propName, Object value) Sets the value of of a structure property represented as a member variable.voidsetNativeDataType(Integer dataType) Sets the result set column native data type.voidsetPosition(Integer position) Sets the position of this column.validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Validates this structure.Methods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getLocalProperty, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference
-
Field Details
-
RESULT_SET_COLUMN_STRUCT
Name of this structure. Matches the definition in the meta-data dictionary.- See Also:
-
POSITION_MEMBER
Name of the position member.- See Also:
-
NAME_MEMBER
Name of the column name member.- See Also:
-
DATA_TYPE_MEMBER
Name of the data type member.- See Also:
-
NATIVE_DATA_TYPE_MEMBER
Name of the member indicating the native (database) data type code.- See Also:
-
-
Constructor Details
-
ResultSetColumn
public ResultSetColumn()
-
-
Method Details
-
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.- Returns:
- the internal name of the structure a defined in the meta-data dictionary.
-
getIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.StructureReturns the value of a structure property represented as a member variable.- Specified by:
getIntrinsicPropertyin classorg.eclipse.birt.report.model.core.Structure- 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.- Specified by:
setIntrinsicPropertyin classorg.eclipse.birt.report.model.core.Structure- Parameters:
propName- the name of the property to setvalue- the property value
-
getColumnName
Returns the column name.- Returns:
- the column name.
-
setColumnName
Sets the column name.- Parameters:
columnName- the column name to set
-
getDataType
Returns the data type of this column. The possible values are defined inDesignChoiceConstants, and they 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 column.
-
setDataType
Sets the data type of this column. The allowed values are defined inDesignChoiceConstants, and they 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
-
getPosition
Returns the position of this parameter.- Returns:
- the position of this parameter
-
setPosition
Sets the position of this column.- Parameters:
position- the position to set
-
handle
Description copied from class:org.eclipse.birt.report.model.core.StructureCreates the specific handle of this structure. This handle is always created.- Specified by:
handlein classorg.eclipse.birt.report.model.core.Structure- 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.
-
getNativeDataType
Returns the native data type.- Returns:
- the result set column native data type.
-
setNativeDataType
Sets the result set column native data type.- Parameters:
dataType- the native data type to set.
-
validate
public List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Validates this structure. The following are the rules:- The column name is required.
- Overrides:
validatein classorg.eclipse.birt.report.model.core.Structure- Parameters:
module- the moduleelement- the element contains this structure- Returns:
- the semantic error list
- See Also:
-
Structure.validate(Module, org.eclipse.birt.report.model.core.DesignElement)
-