Class ColumnHintHandle
- 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.ColumnHintHandle
-
public class ColumnHintHandle extends StructureHandle
Represents the handle of column hint. The column hint provides the hint about result set columns.- Column Name
- a column hint has a required name. It keys the column hint to a column within the result set.
- Alias
- a column hint has an optional alias. It provides an 'alias' name used for the column within the report.
- Searching
- a column hint has an optional searching. It indicates how the column will be used when searching.
- Export
- a column hint has an optional export. It determines how the column will be used when exporting data.
- Analysis
- a column hint has an optional analysis. It determines how the column is used when exporting the data to an OLAP cube.
- Parent Level
- a column hint has an optional parent level. It is used when a column's
ANALYSIS_MEMBER
property is set toANALYSIS_TYPE_DIMENSION
orANALYSIS_TYPE_DETAIL
. ForANALYSIS_TYPE_DIMENSION
, this property establishes the dimension hierarchy. - Format
- a column hint has an optional format. It is used to format the column data when displaying the value in the viewing UI, especially within the search results.
- Display Name
- a column hint has an optional display name. It provides the an optional localizable display name for the column.
- Display Name ID
- a column hint has an optional display name ID. It provides the key to localize the display name.
- Help Text
- a column hint has an optional help text. It provides optional localizable descriptive text that explains the column to the end user.
- Help Text ID
- a column hint has an optional help text ID. It provides the key to localize the help text.
-
-
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
Constructors Constructor Description ColumnHintHandle(SimpleValueHandle valueHandle, int index)
Constructs the handle of computed column.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ExpressionHandle
getACLExpression()
Gets the expression handle for theACLExpression
member.ActionHandle
getActionHandle()
Returns a handle to work with the action property, action is a structure that defines a hyperlink.java.lang.String
getAlias()
Returns the alias name of this column.java.lang.String
getAnalysis()
Returns the analysis option.java.lang.String
getAnalysisColumn()
Gets the analysis column.java.lang.String
getColumnName()
Returns the column name.java.lang.String
getDescription()
Deprecated.java.lang.String
getDescriptionKey()
Deprecated.int
getDisplayLength()
Deprecated.java.lang.String
getDisplayName()
Returns the display name.java.lang.String
getDisplayNameKey()
Returns the resource key for display name.java.lang.String
getExport()
Returns the export option.java.lang.String
getFormat()
Deprecated.java.lang.String
getHeading()
Gets the heading of the column.java.lang.String
getHeadingKey()
Gets the resource key of the heading of the column.java.lang.String
getHelpText()
Returns the help text.java.lang.String
getHelpTextKey()
Returns the resource key for help text.java.lang.String
getHorizontalAlign()
Gets the horizontal alignment of the column.java.lang.String
getParentLevel()
Returns the parent level.java.lang.String
getSearching()
Returns the searching option.java.lang.String
getTextFormat()
Deprecated.FormatValue
getValueFormat()
Gets the value format of the column.boolean
isCompressed()
Gets the flag which indicates whether the column needs to be compressed.boolean
isIndexColumn()
Gets the flag which indicates whether the column should be generated with index.boolean
isOnColumnLayout()
Gets the hint if the dimension data element should be layout on column.ActionHandle
setAction(Action action)
Set an action on the image.void
setAlias(java.lang.String alias)
Sets the alias name of this column.void
setAnalysis(java.lang.String analysis)
Sets the analysis option.void
setAnalysisColumn(java.lang.String column)
Sets the analysis column.void
setColumnName(java.lang.String columnName)
Sets the column name.void
setCompresssed(boolean compressed)
Sets the flag which indicates whether the column needs to be compressed.void
setDescription(java.lang.String description)
Deprecated.void
setDescriptionKey(java.lang.String descriptionID)
Deprecated.void
setDisplayLength(int displayLength)
Deprecated.void
setDisplayName(java.lang.String displayName)
Sets the display name.void
setDisplayNameKey(java.lang.String displayNameResourceKey)
Sets the resource key for display name.void
setExport(java.lang.String export)
Sets the export option.void
setFormat(java.lang.String format)
Deprecated.void
setHeading(java.lang.String heading)
Sets the heading of the column.void
setHeadingKey(java.lang.String headingID)
Sets the resource key of the heading of the column.void
setHelpText(java.lang.String helpText)
Sets the help text.void
setHelpTextKey(java.lang.String helpTextResourceKey)
Sets the resource key for help text.void
setHorizontalAlign(java.lang.String align)
Sets the horizontal alignment of the column.void
setIndexColumn(boolean indexColumn)
Sets the flag which indicates whether the column should be generated with index.void
setOnColumnLayout(boolean onColumnLayout)
Sets the hint if the dimension data element should be layout on column.void
setParentLevel(java.lang.String parentLevel)
Sets the parent level.void
setSearching(java.lang.String searching)
Sets the searching option.void
setTextFormat(java.lang.String format)
Deprecated.void
setValueFormat(FormatValue format)
Sets the value format of the column.void
setWordWrap(boolean wordWrap)
Deprecated.boolean
wordWrap()
Deprecated.-
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 Detail
-
ColumnHintHandle
public ColumnHintHandle(SimpleValueHandle valueHandle, int index)
Constructs the handle of computed column.- Parameters:
valueHandle
- the value handle for computed column list of one propertyindex
- the position of this computed column in the list
-
-
Method Detail
-
getAlias
public java.lang.String getAlias()
Returns the alias name of this column.- Returns:
- the alias name of this column
-
setAlias
public void setAlias(java.lang.String alias)
Sets the alias name of this column.- Parameters:
alias
- the alias name to set
-
getAnalysis
public java.lang.String getAnalysis()
Returns the analysis option. The possible values are defined inDesignChoiceConstants
, and they are- ANALYSIS_TYPE_DIMENSION
- ANALYSIS_TYPE_ATTRIBUTE
- ANALYSIS_TYPE_MEASURE
- Returns:
- the analysis option
-
setAnalysis
public void setAnalysis(java.lang.String analysis) throws SemanticException
Sets the analysis option. The allowed values are defined inDesignChoiceConstants
, and they are- ANALYSIS_TYPE_DIMENSION
- ANALYSIS_TYPE_ATTRIBUTE
- ANALYSIS_TYPE_MEASURE
- Parameters:
analysis
- the analysis option to set- Throws:
SemanticException
- if the analysis is not in the choice list.
-
getColumnName
public java.lang.String getColumnName()
Returns the column name.- Returns:
- the column name
-
setColumnName
public void setColumnName(java.lang.String columnName) throws SemanticException
Sets the column name.- Parameters:
columnName
- the column name to set- Throws:
SemanticException
- value required exception.
-
getDisplayName
public java.lang.String getDisplayName()
Returns the display name.- Returns:
- the display name
-
setDisplayName
public void setDisplayName(java.lang.String displayName)
Sets the display name.- Parameters:
displayName
- the display name to set
-
getDisplayNameKey
public java.lang.String getDisplayNameKey()
Returns the resource key for display name.- Returns:
- the resource key for display name
-
setDisplayNameKey
public void setDisplayNameKey(java.lang.String displayNameResourceKey)
Sets the resource key for display name.- Parameters:
displayNameResourceKey
- the resource key to set
-
getExport
public java.lang.String getExport()
Returns the export option. The possible values are defined inDesignChoiceConstants
, and they are- EXPORT_TYPE_NONE
- EXPORT_TYPE_IF_REALIZED
- EXPORT_TYPE_ALWAYS
- Returns:
- the export option
-
setExport
public void setExport(java.lang.String export) throws SemanticException
Sets the export option. The allowed values are defined inDesignChoiceConstants
, and they are- EXPORT_TYPE_NONE
- EXPORT_TYPE_IF_REALIZED
- EXPORT_TYPE_ALWAYS
- Parameters:
export
- the export option to set- Throws:
SemanticException
- if the export is not in the choice list.
-
getFormat
@Deprecated public java.lang.String getFormat()
Deprecated.Returns the format option.- Returns:
- the format option
-
setFormat
@Deprecated public void setFormat(java.lang.String format)
Deprecated.Sets the format option.- Parameters:
format
- the format option to set
-
getHelpText
public java.lang.String getHelpText()
Returns the help text.- Returns:
- the help text.
-
setHelpText
public void setHelpText(java.lang.String helpText)
Sets the help text.- Parameters:
helpText
- the help text to set
-
getHelpTextKey
public java.lang.String getHelpTextKey()
Returns the resource key for help text.- Returns:
- the resource key for help text
-
setHelpTextKey
public void setHelpTextKey(java.lang.String helpTextResourceKey)
Sets the resource key for help text.- Parameters:
helpTextResourceKey
- the resource key to set
-
getParentLevel
public java.lang.String getParentLevel()
Returns the parent level.- Returns:
- the parent level
-
setParentLevel
public void setParentLevel(java.lang.String parentLevel)
Sets the parent level.- Parameters:
parentLevel
- the parent level to set
-
getSearching
public java.lang.String getSearching()
Returns the searching option. The possible values are defined inDesignChoiceConstants
, and they are- SEARCH_TYPE_ANY
- SEARCH_TYPE_INDEXED
- SEARCH_TYPE_NONE
- Returns:
- the searching option
-
setSearching
public void setSearching(java.lang.String searching) throws SemanticException
Sets the searching option. The allowed values are defined inDesignChoiceConstants
, and they are- SEARCH_TYPE_ANY
- SEARCH_TYPE_INDEXED
- SEARCH_TYPE_NONE
- Parameters:
searching
- the searching option to set- Throws:
SemanticException
- if the searching is not in the choice list.
-
isOnColumnLayout
public boolean isOnColumnLayout()
Gets the hint if the dimension data element should be layout on column.- Returns:
- true if the dimension data element should be layout on column, or false the dimension data element should be layout on row.
-
setOnColumnLayout
public void setOnColumnLayout(boolean onColumnLayout) throws SemanticException
Sets the hint if the dimension data element should be layout on column.- Parameters:
onColumnLayout
- the hint if the dimension data element should be layout on column.- Throws:
SemanticException
-
getHeading
public java.lang.String getHeading()
Gets the heading of the column.- Returns:
- the heading
-
setHeading
public void setHeading(java.lang.String heading)
Sets the heading of the column.- Parameters:
heading
- the new heading
-
getHeadingKey
public java.lang.String getHeadingKey()
Gets the resource key of the heading of the column.- Returns:
- the resource key of the heading
-
setHeadingKey
public void setHeadingKey(java.lang.String headingID)
Sets the resource key of the heading of the column.- Parameters:
headingID
- the new resource key of the heading
-
getDisplayLength
@Deprecated public int getDisplayLength()
Deprecated.Gets the display length of the column.- Returns:
- the display length
-
setDisplayLength
@Deprecated public void setDisplayLength(int displayLength)
Deprecated.Sets the display length of the column.- Parameters:
displayLength
- the new display length
-
getHorizontalAlign
public java.lang.String getHorizontalAlign()
Gets the horizontal alignment of the column. The returned value may be one of the constants defined inDesignChoiceConstants
:TEXT_ALIGN_LEFT
TEXT_ALIGN_RIGHT
TEXT_ALIGN_CENTER
TEXT_ALIGN_JUSTIFY
- Returns:
- the horizontal alignment
-
setHorizontalAlign
public void setHorizontalAlign(java.lang.String align) throws SemanticException
Sets the horizontal alignment of the column. The value should be one of the constants defined inDesignChoiceConstants
:TEXT_ALIGN_LEFT
TEXT_ALIGN_RIGHT
TEXT_ALIGN_CENTER
TEXT_ALIGN_JUSTIFY
- Parameters:
align
- the new horizontal alignment- Throws:
SemanticException
- if the align is not defined.
-
wordWrap
@Deprecated public boolean wordWrap()
Deprecated.Gets the hint if the word needs to wrap.- Returns:
- true if the word needs to wrap, otherwise false.
-
setWordWrap
@Deprecated public void setWordWrap(boolean wordWrap)
Deprecated.Sets the hint if the word needs to wrap.- Parameters:
wordWrap
- the hint value indicates if the word needs to wrap.
-
getTextFormat
@Deprecated public java.lang.String getTextFormat()
Deprecated.Gets the text format of the column. The returned value may be one of the constants defined inDesignChoiceConstants
:STRING_FORMAT_TYPE_UNFORMATTED
STRING_FORMAT_TYPE_UPPERCASE
STRING_FORMAT_TYPE_LOWERCASE
STRING_FORMAT_TYPE_CUSTOM
STRING_FORMAT_TYPE_ZIP_CODE
STRING_FORMAT_TYPE_ZIP_CODE_4
STRING_FORMAT_TYPE_PHONE_NUMBER
STRING_FORMAT_TYPE_SOCIAL_SECURITY_NUMBER
- Returns:
- the text format of the column
-
setTextFormat
@Deprecated public void setTextFormat(java.lang.String format) throws SemanticException
Deprecated.Sets the text format of the column. The value should be one of the constants defined inDesignChoiceConstants
:STRING_FORMAT_TYPE_UNFORMATTED
STRING_FORMAT_TYPE_UPPERCASE
STRING_FORMAT_TYPE_LOWERCASE
STRING_FORMAT_TYPE_CUSTOM
STRING_FORMAT_TYPE_ZIP_CODE
STRING_FORMAT_TYPE_ZIP_CODE_4
STRING_FORMAT_TYPE_PHONE_NUMBER
STRING_FORMAT_TYPE_SOCIAL_SECURITY_NUMBER
- Parameters:
format
- the new text format- Throws:
SemanticException
- if the format is not defined.
-
getDescription
@Deprecated public java.lang.String getDescription()
Deprecated.Gets the description of the column.- Returns:
- the description
-
setDescription
@Deprecated public void setDescription(java.lang.String description)
Deprecated.Sets the description of the column.- Parameters:
description
- the new description
-
getDescriptionKey
@Deprecated public java.lang.String getDescriptionKey()
Deprecated.Gets the resource key of the description of the column.- Returns:
- the resource key of the description
-
setDescriptionKey
@Deprecated public void setDescriptionKey(java.lang.String descriptionID)
Deprecated.Sets the resource key of the description of the column.- Parameters:
descriptionID
- the new resource key of the description
-
getActionHandle
public ActionHandle getActionHandle()
Returns a handle to work with the action property, action is a structure that defines a hyperlink.- Returns:
- a handle to the action property, return
null
if the action has not been set on the column hint; otherwise return null - See Also:
ActionHandle
-
setAction
public ActionHandle setAction(Action action) throws SemanticException
Set an action on the image.- Parameters:
action
- new action to be set on the image, it represents a bookmark link, hyperlink, and drill through etc.- Returns:
- a handle to the action property, return
null
if the action has not been set on the image. - Throws:
SemanticException
- if member of the action is not valid.
-
getACLExpression
public ExpressionHandle getACLExpression()
Gets the expression handle for theACLExpression
member.- Returns:
-
getAnalysisColumn
public java.lang.String getAnalysisColumn()
Gets the analysis column.- Returns:
- the analysis column.
-
setAnalysisColumn
public void setAnalysisColumn(java.lang.String column) throws SemanticException
Sets the analysis column.- Parameters:
column
- the column to set- Throws:
SemanticException
-
getValueFormat
public FormatValue getValueFormat()
Gets the value format of the column.- Returns:
- the value format
-
setValueFormat
public void setValueFormat(FormatValue format) throws SemanticException
Sets the value format of the column.- Parameters:
format
- the value format to set- Throws:
SemanticException
-
isIndexColumn
public boolean isIndexColumn()
Gets the flag which indicates whether the column should be generated with index.- Returns:
- true if the column should be generated with index, otherwise false
-
setIndexColumn
public void setIndexColumn(boolean indexColumn) throws SemanticException
Sets the flag which indicates whether the column should be generated with index.- Parameters:
indexColumn
- the new flag to set- Throws:
SemanticException
-
isCompressed
public boolean isCompressed()
Gets the flag which indicates whether the column needs to be compressed.- Returns:
- true if the column needs to be compressed, otherwise false.
-
setCompresssed
public void setCompresssed(boolean compressed) throws SemanticException
Sets the flag which indicates whether the column needs to be compressed.- Parameters:
compressed
- the new flag to set- Throws:
SemanticException
-
-