|
||||||||||
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.ColumnHintHandle
public class ColumnHintHandle
Represents the handle of column hint. The column hint provides the hint about result set columns.
ANALYSIS_MEMBER
property is set to
ANALYSIS_TYPE_DIMENSION
or ANALYSIS_TYPE_DETAIL
.
For ANALYSIS_TYPE_DIMENSION
, this property establishes the
dimension hierarchy.
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
structRef |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
ColumnHintHandle(SimpleValueHandle valueHandle,
int index)
Constructs the handle of computed column. |
Method Summary | |
---|---|
java.lang.String |
getAlias()
Returns the alias name of this column. |
java.lang.String |
getAnalysis()
Returns the analysis option. |
java.lang.String |
getColumnName()
Returns the column name. |
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()
Returns the format option. |
java.lang.String |
getHelpText()
Returns the help text. |
java.lang.String |
getHelpTextKey()
Returns the resource key for help text. |
java.lang.String |
getParentLevel()
Returns the parent level. |
java.lang.String |
getSearching()
Returns the searching option. |
void |
setAlias(java.lang.String alias)
Sets the alias name of this column. |
void |
setAnalysis(java.lang.String analysis)
Sets the analysis option. |
void |
setColumnName(java.lang.String columnName)
Sets the column name. |
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)
Sets the format option. |
void |
setHelpText(java.lang.String helpText)
Sets the help text. |
void |
setHelpTextKey(java.lang.String helpTextResourceKey)
Sets the resource key for help text. |
void |
setParentLevel(java.lang.String parentLevel)
Sets the parent level. |
void |
setSearching(java.lang.String searching)
Sets the searching option. |
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently |
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 ColumnHintHandle(SimpleValueHandle valueHandle, int index)
valueHandle
- the value handle for computed column list of one propertyindex
- the position of this computed column in the listMethod Detail |
---|
public java.lang.String getAlias()
public void setAlias(java.lang.String alias)
alias
- the alias name to setpublic java.lang.String getAnalysis()
DesignChoiceConstants
,
and they are
public void setAnalysis(java.lang.String analysis) throws SemanticException
DesignChoiceConstants
,
and they are
analysis
- the analysis option to set
SemanticException
- if the analysis is not in the choice list.public java.lang.String getColumnName()
public void setColumnName(java.lang.String columnName) throws SemanticException
columnName
- the column name to set
SemanticException
- value required exception.public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String displayName)
displayName
- the display name to setpublic java.lang.String getDisplayNameKey()
public void setDisplayNameKey(java.lang.String displayNameResourceKey)
displayNameResourceKey
- the resource key to setpublic java.lang.String getExport()
DesignChoiceConstants
,
and they are
public void setExport(java.lang.String export) throws SemanticException
DesignChoiceConstants
,
and they are
export
- the export option to set
SemanticException
- if the export is not in the choice list.public java.lang.String getFormat()
public void setFormat(java.lang.String format)
format
- the format option to setpublic java.lang.String getHelpText()
public void setHelpText(java.lang.String helpText)
helpText
- the help text to setpublic java.lang.String getHelpTextKey()
public void setHelpTextKey(java.lang.String helpTextResourceKey)
helpTextResourceKey
- the resource key to setpublic java.lang.String getParentLevel()
public void setParentLevel(java.lang.String parentLevel)
parentLevel
- the parent level to setpublic java.lang.String getSearching()
DesignChoiceConstants
,
and they are
public void setSearching(java.lang.String searching) throws SemanticException
DesignChoiceConstants
,
and they are
searching
- the searching option to set
SemanticException
- if the searching is not in the choice list.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |