Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api.olap
Class LevelHandle

    java.lang.Object
      org.eclipse.birt.report.model.api.DesignElementHandle
          org.eclipse.birt.report.model.api.ReportElementHandle
              org.eclipse.birt.report.model.api.olap.LevelHandle

All Implemented Interfaces:
  org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.ILevelModel

Direct Known Subclasses:
  OdaLevelHandle, TabularLevelHandle

    public abstract class LevelHandle

extends ReportElementHandle
implements org.eclipse.birt.report.model.elements.interfaces.ILevelModel

Represents a level element.

See Also:
  `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 org.eclipse.birt.report.model.api.DesignElementHandle
`add, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setEncryption, setEventHandlerClass, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### LevelHandle

    public 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. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.

  Parameters:
    `module` - the module
    `element` - the model representation of the element

Method Detail

### attributesIterator

    public java.util.Iterator attributesIterator()

  Returns the iterator of attributes. The element in the iterator is a `LevelAttributeHandle` for TabularLevel. To OdaLevel, each member is `OdaLevelAttributeHandle`.

  Returns:
    the iterator of attribute string list

### staticValuesIterator

    public java.util.Iterator staticValuesIterator()

  Returns the iterator of static values. The element in the iterator is instanceof `RuleHandle`.

  Returns:
    iterator of static values

### setIntervalBase

    public void setIntervalBase(java.lang.String intervalBase)
                         throws SemanticException

  Sets the base of the interval property of this level.IntervalBase, in conjunction with Interval and IntervalRange, determines how data is divided into levels.

  Parameters:
    `intervalBase` - interval base property value.
  Throws:
    `SemanticException` - if the property is locked.

### getIntervalBase

    public java.lang.String getIntervalBase()

  Return the interval base property value of this level.

  Returns:
    interval baseF property value of this level.

### getInterval

    public java.lang.String getInterval()

  Returns the interval of this level. The return value is defined in `DesignChoiceConstants` and can be one of:
  - `INTERVAL_NONE`
  - `INTERVAL_PREFIX`
  - `INTERVAL_INTERVAL`

  Returns:
    the interval value as a string

### setInterval

    public void setInterval(java.lang.String interval)
                     throws SemanticException

  Returns the interval of this level. The input value is defined in `DesignChoiceConstants` and can be one of:
  - `INTERVAL_NONE`
  - `INTERVAL_PREFIX`
  - `INTERVAL_INTERVAL`

  Parameters:
    `interval` - the interval value as a string
  Throws:
    `SemanticException` - if the property is locked or the input value is not one of the above.

### getIntervalRange

    public double getIntervalRange()

  Returns the interval range of this level.

  Returns:
    the interval range value as a double

### setIntervalRange

    public void setIntervalRange(double intervalRange)
                          throws SemanticException

  Returns the interval range of this level.

  Parameters:
    `intervalRange` - the interval range value as a double
  Throws:
    `SemanticException` - if the property is locked.

### setIntervalRange

    public void setIntervalRange(java.lang.String intervalRange)
                          throws SemanticException

  Sets the interval range of this level.

  Parameters:
    `intervalRange` - the interval range value as a string.value is locale dependent.
  Throws:
    `SemanticException` - if the property is locked.

### getLevelType

    public java.lang.String getLevelType()

  Returns the level type of this level. The returned value is one of:
  - `LEVEL_TYPE_DYNAMIC`
  - `LEVEL_TYPE_MIRRORED`

  Returns:
    the level type

### setLevelType

    public void setLevelType(java.lang.String levelType)
                      throws SemanticException

  Sets the level type. The input value is defined in `DesignChoiceConstants` and can be one of:
  - `LEVEL_TYPE_DYNAMIC`
  - `LEVEL_TYPE_MIRRORED`

  Parameters:
    `levelType` -
  Throws:
    `SemanticException`

### getDataType

    public java.lang.String getDataType()

  Returns the data type of this level. The possible values are defined in `DesignChoiceConstants`, 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 level.

### setDataType

    public void setDataType(java.lang.String dataType)
                     throws SemanticException

  Sets the data type of this level. The allowed values are defined in `DesignChoiceConstants`, 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.

### valueAccessControlsIterator

    public java.util.Iterator valueAccessControlsIterator()

  Returns an iterator for the value access controls. Each object returned is of type `ValueAccessControlHandle`.

  Returns:
    the iterator for user accesses defined on this cube.

### getDateTimeLevelType

    public java.lang.String getDateTimeLevelType()

  Returns the date-time type of this level. The possible values are defined in `DesignChoiceConstants`, and they are:
  - DATE_TIME_LEVEL_TYPE_YEAR
  - DATE_TIME_LEVEL_TYPE_MONTH
  - DATE_TIME_LEVEL_TYPE_QUARTER
  - DATE_TIME_LEVEL_TYPE_WEEK
  - DATE_TIME_LEVEL_TYPE_DAY
  - DATE_TIME_LEVEL_TYPE_HOUR
  - DATE_TIME_LEVEL_TYPE_MINUTE
  - DATE_TIME_LEVEL_TYPE_SECOND

  Returns:
    the date-time type of this level.

### setDateTimeLevelType

    public void setDateTimeLevelType(java.lang.String dateTimeType)
                              throws SemanticException

  Sets the date-time type of this level. The allowed values are defined in `DesignChoiceConstants`, and they are:
  - DATE_TIME_LEVEL_TYPE_YEAR
  - DATE_TIME_LEVEL_TYPE_MONTH
  - DATE_TIME_LEVEL_TYPE_QUARTER
  - DATE_TIME_LEVEL_TYPE_WEEK
  - DATE_TIME_LEVEL_TYPE_DAY
  - DATE_TIME_LEVEL_TYPE_HOUR
  - DATE_TIME_LEVEL_TYPE_MINUTE
  - DATE_TIME_LEVEL_TYPE_SECOND

  Parameters:
    `dateTimeType` - the date-time type to set
  Throws:
    `SemanticException` - if the dateTimeType is not in the choice list.

### getDateTimeFormat

    public java.lang.String getDateTimeFormat()

  Returns the date-time format of this level.

  Returns:
    the date-time format of this level.

### setDateTimeFormat

    public void setDateTimeFormat(java.lang.String dateTimeFormat)
                           throws SemanticException

  Sets the date-time format of this level.

  Parameters:
    `dateTimeFormat` - the date-time format to set
  Throws:
    `SemanticException` - if the date-time-format is locked

### setDefaultValue

    public void setDefaultValue(java.lang.String defaultValue)
                         throws SemanticException

  Sets the default value of this level.

  Parameters:
    `defaultValue` - the default value.
  Throws:
    `SemanticException`

### getDefaultValue

    public java.lang.String getDefaultValue()

  Gets the default value of this level.

  Returns:
    the default value.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.