|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.olap.LevelHandle
public abstract class LevelHandle
Represents a level element.
Level
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.ILevelModel |
---|
ATTRIBUTES_PROP, DATA_TYPE_PROP, DATE_TIME_FORMAT_PROP, DATE_TIME_LEVEL_TYPE, DEFAULT_VALUE_PROP, INTERVAL_BASE_PROP, INTERVAL_PROP, INTERVAL_RANGE_PROP, LEVEL_TYPE_PROP, STATIC_VALUES_PROP, VALUE_ACCESS_CONTROLS_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
---|
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
LevelHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle for the given design and design element. |
Method Summary | |
---|---|
java.util.Iterator |
attributesIterator()
Returns the iterator of attributes. |
java.lang.String |
getDataType()
Returns the data type of this level. |
java.lang.String |
getDateTimeFormat()
Returns the date-time format of this level. |
java.lang.String |
getDateTimeLevelType()
Returns the date-time type of this level. |
java.lang.String |
getDefaultValue()
Gets the default value of this level. |
java.lang.String |
getInterval()
Returns the interval of this level. |
java.lang.String |
getIntervalBase()
Return the interval base property value of this level. |
double |
getIntervalRange()
Returns the interval range of this level. |
java.lang.String |
getLevelType()
Returns the level type of this level. |
void |
setDataType(java.lang.String dataType)
Sets the data type of this level. |
void |
setDateTimeFormat(java.lang.String dateTimeFormat)
Sets the date-time format of this level. |
void |
setDateTimeLevelType(java.lang.String dateTimeType)
Sets the date-time type of this level. |
void |
setDefaultValue(java.lang.String defaultValue)
Sets the default value of this level. |
void |
setInterval(java.lang.String interval)
Returns the interval of this level. |
void |
setIntervalBase(java.lang.String intervalBase)
Sets the base of the interval property of this level.IntervalBase, in conjunction with Interval and IntervalRange, determines how data is divided into levels. |
void |
setIntervalRange(double intervalRange)
Returns the interval range of this level. |
void |
setIntervalRange(java.lang.String intervalRange)
Sets the interval range of this level. |
void |
setLevelType(java.lang.String levelType)
Sets the level type. |
java.util.Iterator |
staticValuesIterator()
Returns the iterator of static values. |
java.util.Iterator |
valueAccessControlsIterator()
Returns an iterator for the value access controls. |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LevelHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
---|
public java.util.Iterator attributesIterator()
LevelAttributeHandle
for TabularLevel. To OdaLevel, each
member is OdaLevelAttributeHandle
.
public java.util.Iterator staticValuesIterator()
RuleHandle
.
public void setIntervalBase(java.lang.String intervalBase) throws SemanticException
intervalBase
- interval base property value.
SemanticException
- if the property is locked.public java.lang.String getIntervalBase()
public java.lang.String getInterval()
DesignChoiceConstants
and can be one of:
INTERVAL_NONE
INTERVAL_PREFIX
INTERVAL_INTERVAL
public void setInterval(java.lang.String interval) throws SemanticException
DesignChoiceConstants
and can be one of:
INTERVAL_NONE
INTERVAL_PREFIX
INTERVAL_INTERVAL
interval
- the interval value as a string
SemanticException
- if the property is locked or the input value is not one of the
above.public double getIntervalRange()
public void setIntervalRange(double intervalRange) throws SemanticException
intervalRange
- the interval range value as a double
SemanticException
- if the property is locked.public void setIntervalRange(java.lang.String intervalRange) throws SemanticException
intervalRange
- the interval range value as a string.value is locale dependent.
SemanticException
- if the property is locked.public java.lang.String getLevelType()
LEVEL_TYPE_DYNAMIC
LEVEL_TYPE_MIRRORED
public void setLevelType(java.lang.String levelType) throws SemanticException
DesignChoiceConstants
and can be one of:
LEVEL_TYPE_DYNAMIC
LEVEL_TYPE_MIRRORED
levelType
-
SemanticException
public java.lang.String getDataType()
DesignChoiceConstants
,
and they are:
public void setDataType(java.lang.String dataType) throws SemanticException
DesignChoiceConstants
,
and they are:
dataType
- the data type to set
SemanticException
- if the dataType is not in the choice list.public java.util.Iterator valueAccessControlsIterator()
ValueAccessControlHandle
.
public java.lang.String getDateTimeLevelType()
DesignChoiceConstants
, and
they are:
public void setDateTimeLevelType(java.lang.String dateTimeType) throws SemanticException
DesignChoiceConstants
,
and they are:
dateTimeType
- the date-time type to set
SemanticException
- if the dateTimeType is not in the choice list.public java.lang.String getDateTimeFormat()
public void setDateTimeFormat(java.lang.String dateTimeFormat) throws SemanticException
dateTimeFormat
- the date-time format to set
SemanticException
- if the date-time-format is lockedpublic void setDefaultValue(java.lang.String defaultValue) throws SemanticException
defaultValue
- the default value.
SemanticException
public java.lang.String getDefaultValue()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |