|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.PropertyStructure
org.eclipse.birt.report.model.api.elements.structures.ColumnHint
public class ColumnHint
This class represents one column hint used by data sets.
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 column hint has the following properties:
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 | |
---|---|
static java.lang.String |
ALIAS_MEMBER
Name of the alias member. |
static java.lang.String |
ANALYSIS_MEMBER
Name of the analysis member. |
static java.lang.String |
COLUMN_HINT_STRUCT
Name of this structure. |
static java.lang.String |
COLUMN_NAME_MEMBER
Name of the column name member. |
static java.lang.String |
DISPLAY_NAME_ID_MEMBER
Name of the display name ID member. |
static java.lang.String |
DISPLAY_NAME_MEMBER
Name of the display name member. |
static java.lang.String |
EXPORT_MEMBER
Name of the export member. |
static java.lang.String |
FORMAT_MEMBER
Name of the format member. |
static java.lang.String |
HELP_TEXT_ID_MEMBER
Name of the help text ID member. |
static java.lang.String |
HELP_TEXT_MEMBER
Name of the help text member. |
static java.lang.String |
PARENT_LEVEL_MEMBER
Name of the parent level member. |
static java.lang.String |
SEARCHING_MEMBER
Name of the searching member. |
Fields inherited from class org.eclipse.birt.report.model.core.PropertyStructure |
---|
propValues |
Constructor Summary | |
---|---|
ColumnHint()
|
Method Summary | |
---|---|
java.lang.String |
getStructName()
Returns the name of the structure definition. |
StructureHandle |
handle(SimpleValueHandle valueHandle,
int index)
|
java.util.List |
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.PropertyStructure |
---|
clone, getIntrinsicProperty, getLocalProperty, getLocalProperty, setIntrinsicProperty, setProperty |
Methods inherited from class org.eclipse.birt.report.model.core.Structure |
---|
copy, equals, getContext, getDefn, getElement, getHandle, getHandle, getListMemberRef, getObjectDefn, getProperty, getProperty, getReferencableProperty, isDesignTime, isReferencable, setContext, setProperty, updateReference |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COLUMN_HINT_STRUCT
public static final java.lang.String COLUMN_NAME_MEMBER
public static final java.lang.String ALIAS_MEMBER
public static final java.lang.String SEARCHING_MEMBER
public static final java.lang.String EXPORT_MEMBER
public static final java.lang.String ANALYSIS_MEMBER
EXPORT_MEMBER
property above.
public static final java.lang.String PARENT_LEVEL_MEMBER
ANALYSIS_MEMBER
property is set to
ANALYSIS_TYPE_DIMENSION
or
ANALYSIS_TYPE_DETAIL
. For
ANALYSIS_TYPE_DIMENSION
, this property establishes the
dimension hierarchy. Lower (more detailed) dimensions identify their
parent (more general) dimensions. For ANALYSIS_TYPE_DETAIL
,
this property identifies the dimension for which this column is a detail.
public static final java.lang.String FORMAT_MEMBER
public static final java.lang.String DISPLAY_NAME_ID_MEMBER
public static final java.lang.String DISPLAY_NAME_MEMBER
public static final java.lang.String HELP_TEXT_ID_MEMBER
public static final java.lang.String HELP_TEXT_MEMBER
Constructor Detail |
---|
public ColumnHint()
Method Detail |
---|
public java.lang.String getStructName()
IStructure
public java.util.List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
validate
in class org.eclipse.birt.report.model.core.Structure
Structure.validate(Module,
org.eclipse.birt.report.model.core.DesignElement)
public StructureHandle handle(SimpleValueHandle valueHandle, int index)
handle
in class org.eclipse.birt.report.model.core.Structure
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |