Class ResultSetColumnHandle
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.ResultSetColumnHandle
- Direct Known Subclasses:
OdaResultSetColumnHandle
Represents the handle of one column in the result set. The result set column
defines the data in which column is in the result set.
- 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
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
ConstructorsConstructorDescriptionResultSetColumnHandle
(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context) ResultSetColumnHandle
(SimpleValueHandle valueHandle, int index) Constructs the handle of result set column. -
Method Summary
Modifier and TypeMethodDescriptionReturns the column name.Returns the data type of this column.Returns the native data type.Returns the position that this column is in the result set.void
setColumnName
(String columnName) Sets the column name.void
setDataType
(String dataType) Sets the data type of this column.void
setNativeDataType
(Integer dataType) Sets the result set column native data type.void
setPosition
(Integer position) Sets the position that this column is in the result set.Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, 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
-
Constructor Details
-
ResultSetColumnHandle
Constructs the handle of result set column.- Parameters:
valueHandle
- the value handle for result set column list of one propertyindex
- the position of this result set column in the list
-
ResultSetColumnHandle
public ResultSetColumnHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)
-
-
Method Details
-
getColumnName
Returns the column name.- Returns:
- the column name
-
setColumnName
Sets the column name.- Parameters:
columnName
- the column name to set- Throws:
SemanticException
- value required exception
-
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- Throws:
SemanticException
- if the dataType is not in the choice list.
-
getPosition
Returns the position that this column is in the result set.- Returns:
- the position that this column is in the result set.
-
setPosition
Sets the position that this column is in the result set.- Parameters:
position
- the position to set
-
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.
-