Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.4.0)

E12063-05

oracle.dss.util
Class MetadataMap

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.Vector
              extended by oracle.dss.util.AbstractMap
                  extended by oracle.dss.util.MetadataMap
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

public class MetadataMap
extends AbstractMap

See Also:
Serialized Form

Field Summary
static java.lang.String METADATA_AGGTYPE
          If METADATA_ISTOTAL is true, then this returns a value of oracle.dss.util.transform.total.AggType.
static java.lang.String METADATA_CHILDCOUNT
           
static java.lang.String METADATA_CURDRILLPATH
          Returns String ID of the current Drill Path.
static java.lang.String METADATA_CURDRILLTARGET
          Returns String ID of current Drill Target for the current Drill Path
static java.lang.String METADATA_DATATYPE
          Measure data type information.
static java.lang.String METADATA_DATAVALUE
          The unique key value of the member, in its original data format.
static java.lang.String METADATA_DATE
          The dimension member, as a Date object.
static java.lang.String METADATA_DATESPAN
          The span, in days, of the specified time dimension member.
static java.lang.String METADATA_DISPLAYNAME
          The name of the dimension member, if available.
static java.lang.String METADATA_DRILL_PARENT_DATE
          The dimension member, as a Date object, for a drilled dimension member's parent.
static java.lang.String METADATA_DRILL_PARENT_DATESPAN
          The span, in days, of the specified drilled time dimension member's parent.
static java.lang.String METADATA_DRILL_PARENT_LONGLABEL
          Long label for a drilled dimension member's parent.
static java.lang.String METADATA_DRILL_PARENT_MEDIUMLABEL
          Medium label for a drilled dimension member's parent.
static java.lang.String METADATA_DRILL_PARENT_SHORTLABEL
          Short label for a drilled dimension member's parent.
static java.lang.String METADATA_DRILLPATHS
          Returns List of valid DrillPathMetadata instances.
static java.lang.String METADATA_DRILLSTATE
          Value that indicates the type of drill available and its icon.
static java.lang.String METADATA_EXTENT
          The extent of the member, expressed in terms of data slices.
static java.lang.String METADATA_FORMAT
          Number format.
static java.lang.String METADATA_HIERARCHY
          Returns String ID of the member's hierarchy, if any.
static java.lang.String METADATA_INDENT
          Number of levels to indent the dimension member.
static java.lang.String METADATA_IS_CALCULATED_MEMBER
          Is the specified member a calculated member? A return value of true indicates that it is.
static java.lang.String METADATA_ISAGG
          Is the specified member considered an aggregate by the provider of data/metadata? true indicates that it is.
static java.lang.String METADATA_ISTOTAL
          Is the specified member located in a total row or column? A return value of true indicates that it is.
static java.lang.String METADATA_LEVEL
          The name of the level of which this item is a member.
static java.lang.String METADATA_LEVEL_LABEL
          The formatted name of the level of which this item is a member.
static java.lang.String METADATA_LEVEL_NAME
          The name, which may be different from the unique name of METADATA_LEVEL of the member's level.
static java.lang.String METADATA_LONGLABEL
          Long label for the dimension member.
static java.lang.String METADATA_MEDIUMLABEL
          Medium label for the dimension member.
static java.lang.String METADATA_PARENT
          Parent dimension member of a member.
static java.lang.String METADATA_PARENT_LEVEL
          Parent dimension member of a member's level.
static java.lang.String METADATA_POSITION
          Position of a member within its hierarchical location.
static java.lang.String METADATA_QUERYPARENT
           
static java.lang.String METADATA_RAWVALUE
          Deprecated. Deprecated since 11.1.1.4.0. See (@link METADATA_DATAVALUE)
static java.lang.String METADATA_REL_INDENT
          Relative level indent number in the cursor for a given dimension.
static java.lang.String METADATA_RELHIERINFO
          Relative hierarchy information.
static java.lang.String METADATA_SHORTLABEL
          Short label for the dimension value.
static java.lang.String METADATA_SORT_ATTR
          An attribute used for sorting in a header, for example.
static java.lang.String METADATA_START
          The starting slice of the member.
static java.lang.String METADATA_UNIQUE_PARENT
           
static java.lang.String METADATA_UNIQUE_VALUE
           
static java.lang.String METADATA_VALUE
          The unique ID of the dimension member.
static java.lang.String METADATA_VALUE_RAW
          Deprecated. Deprecated since 11.1.1.4.0. See (@link METADATA_DATAVALUE)
static java.lang.String METADATA_VIEWSTYLE
          A handle to the ViewStyle that provides style property settings for a cell.
 
Fields inherited from class oracle.dss.util.AbstractMap
MAP_TYPE_NOT_FOUND
 
Fields inherited from class java.util.Vector
capacityIncrement, elementCount, elementData
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
MetadataMap()
          Constructor for an empty map.
MetadataMap(java.util.Enumeration types)
          Constructor that initializes the map from an Enumeration.
MetadataMap(java.lang.String type)
          Constructor that initializes the map with one type.
MetadataMap(java.lang.String[] availableTypes)
          Constructor that initializes the map from an array.
 
Method Summary
 
Methods inherited from class oracle.dss.util.AbstractMap
addType, clone, containsType, getTypeAt, isSuperset, merge, removeType, types
 
Methods inherited from class java.util.Vector
add, add, addAll, addAll, addElement, capacity, clear, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize
 
Methods inherited from class java.util.AbstractList
iterator, listIterator, listIterator
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
iterator, listIterator, listIterator
 

Field Detail

METADATA_VALUE

public static final java.lang.String METADATA_VALUE
The unique ID of the dimension member. The getMemberMetadata method returns a String when you use this constant for its type parameter.

See Also:
Constant Field Values

METADATA_DISPLAYNAME

public static final java.lang.String METADATA_DISPLAYNAME
The name of the dimension member, if available. The getMemberMetadata method returns a String when you use this constant for its type parameter. For the measure dimension, the METADATA_DISPLAYNAME is distinct from the METADATA_VALUE. For other dimensions, which may not have a distinct METADATA_DISPLAYNAME for their members, the return value for the getMemberMetadata method is equivalent to the return value when you use METADATA_VALUE for the type parameter.

See Also:
Constant Field Values

METADATA_LONGLABEL

public static final java.lang.String METADATA_LONGLABEL
Long label for the dimension member. The getMemberMetadata method returns a String when you use this constant for its type parameter..

See Also:
Constant Field Values

METADATA_SHORTLABEL

public static final java.lang.String METADATA_SHORTLABEL
Short label for the dimension value. The getMemberMetadata method returns a String when you use this constant for its type parameter.

See Also:
Constant Field Values

METADATA_INDENT

public static final java.lang.String METADATA_INDENT
Number of levels to indent the dimension member. Indentation levels are based on the place of the member in the hierarchy and the levels of the hierarchy in the cursor. The getMemberMetadata method returns an Integer when you use this constant as its type parameter. To specify indentation for hierarchical dimensions, call setAutoIndent in the CrosstabModelAdapter.

See Also:
Constant Field Values

METADATA_DRILLSTATE

public static final java.lang.String METADATA_DRILLSTATE
Value that indicates the type of drill available and its icon. Use this constant as the type parameter for the getMemberMetadata method to retrieve a constant that describes whether the dimension member has been drilled or can be drilled. The drill state constants begin with the prefix DRILLSTATE_ and are defined in the DataDirector interface.

See Also:
DataDirector.DRILLSTATE_DRILLABLE, DataDirector.DRILLSTATE_IS_DRILLED, DataDirector.DRILLSTATE_NOT_DRILLABLE, Constant Field Values

METADATA_PARENT

public static final java.lang.String METADATA_PARENT
Parent dimension member of a member.

See Also:
Constant Field Values

METADATA_PARENT_LEVEL

public static final java.lang.String METADATA_PARENT_LEVEL
Parent dimension member of a member's level.

See Also:
Constant Field Values

METADATA_DRILL_PARENT_LONGLABEL

public static final java.lang.String METADATA_DRILL_PARENT_LONGLABEL
Long label for a drilled dimension member's parent. The getMemberMetadata method returns a String when you use this constant for its type parameter.

See Also:
Constant Field Values

METADATA_DRILL_PARENT_SHORTLABEL

public static final java.lang.String METADATA_DRILL_PARENT_SHORTLABEL
Short label for a drilled dimension member's parent. The getMemberMetadata method returns a String when you use this constant for its type parameter.

See Also:
Constant Field Values

METADATA_DRILL_PARENT_DATE

public static final java.lang.String METADATA_DRILL_PARENT_DATE
The dimension member, as a Date object, for a drilled dimension member's parent. When you pass this constant as the type parameter, the DataAccess.getMemberMetadata method returns a java.sql.Date.

See Also:
Constant Field Values

METADATA_DRILL_PARENT_DATESPAN

public static final java.lang.String METADATA_DRILL_PARENT_DATESPAN
The span, in days, of the specified drilled time dimension member's parent.

See Also:
Constant Field Values

METADATA_REL_INDENT

public static final java.lang.String METADATA_REL_INDENT
Relative level indent number in the cursor for a given dimension. The relative indent level is the member's indent level minus the minimum indent level for any dimension member in the cursor. The getMemberMetadata method returns an Integer when you use this constant as its type parameter.

See Also:
Constant Field Values

METADATA_LEVEL

public static final java.lang.String METADATA_LEVEL
The name of the level of which this item is a member. When you pass this constant as the type parameter, the DataAccess.getMemberMetadata method returns a String.

See Also:
Constant Field Values

METADATA_LEVEL_LABEL

public static final java.lang.String METADATA_LEVEL_LABEL
The formatted name of the level of which this item is a member. When you pass this constant as the type parameter, the DataAccess.getMemberMetadata method returns a String.

See Also:
Constant Field Values

METADATA_LEVEL_NAME

public static final java.lang.String METADATA_LEVEL_NAME
The name, which may be different from the unique name of METADATA_LEVEL of the member's level. This name is unique in the member's dimension and hierarchy if it is not unique overall. If an implementation does not distinguish between a level name within a dimension/hierarchy and a unique level name, then this type should return the same value as METADATA_LEVEL.

See Also:
Constant Field Values

METADATA_ISTOTAL

public static final java.lang.String METADATA_ISTOTAL
Is the specified member located in a total row or column? A return value of true indicates that it is.

See Also:
Constant Field Values

METADATA_AGGTYPE

public static final java.lang.String METADATA_AGGTYPE
If METADATA_ISTOTAL is true, then this returns a value of oracle.dss.util.transform.total.AggType. Otherwise, null.

See Also:
Constant Field Values

METADATA_ISAGG

public static final java.lang.String METADATA_ISAGG
Is the specified member considered an aggregate by the provider of data/metadata? true indicates that it is. Primarily used for differentiating members for formatting.

See Also:
Constant Field Values

METADATA_DATE

public static final java.lang.String METADATA_DATE
The dimension member, as a Date object. When you pass this constant as the type parameter, the DataAccess.getMemberMetadata method returns a java.sql.Date.

See Also:
Constant Field Values

METADATA_DATESPAN

public static final java.lang.String METADATA_DATESPAN
The span, in days, of the specified time dimension member.

See Also:
Constant Field Values

METADATA_POSITION

public static final java.lang.String METADATA_POSITION
Position of a member within its hierarchical location. The getMemberMetadata method returns an int when you use this constant as its type parameter.

See Also:
Constant Field Values

METADATA_RELHIERINFO

public static final java.lang.String METADATA_RELHIERINFO
Relative hierarchy information. The getMemberMetadata method returns a String when you use this constant as its type parameter.

See Also:
Constant Field Values

METADATA_VALUE_RAW

public static final java.lang.String METADATA_VALUE_RAW
Deprecated. Deprecated since 11.1.1.4.0. See (@link METADATA_DATAVALUE)
The unique ID of the dimension member, left in a raw format. The type of the return value is not necessarily a string.

See Also:
Constant Field Values

METADATA_DATAVALUE

public static final java.lang.String METADATA_DATAVALUE
The unique key value of the member, in its original data format. The type of the return value is not necessarily a string.

See Also:
Constant Field Values

METADATA_UNIQUE_VALUE

public static final java.lang.String METADATA_UNIQUE_VALUE
See Also:
Constant Field Values
For internal use only. Application developers should not use this
The unique mode ID of the dimension member. The getMemberMetadata method returns a String when you use this constant for its type parameter. For OLAP data sources, this may be a hierarchy/level/member value combination. For others, the value may be equal to METADATA_VALUE.

METADATA_MEDIUMLABEL

public static final java.lang.String METADATA_MEDIUMLABEL
Medium label for the dimension member. The getMemberMetadata method returns a String when you use this constant for its type parameter.

See Also:
Constant Field Values

METADATA_FORMAT

public static final java.lang.String METADATA_FORMAT
Number format. The getMemberMetadata method returns a String when you use this constant as its type parameter.

See Also:
Constant Field Values

METADATA_UNIQUE_PARENT

public static final java.lang.String METADATA_UNIQUE_PARENT
See Also:
Constant Field Values

METADATA_DRILL_PARENT_MEDIUMLABEL

public static final java.lang.String METADATA_DRILL_PARENT_MEDIUMLABEL
Medium label for a drilled dimension member's parent. The getMemberMetadata method returns a String when you use this constant for its type parameter.

See Also:
Constant Field Values

METADATA_VIEWSTYLE

public static final java.lang.String METADATA_VIEWSTYLE
A handle to the ViewStyle that provides style property settings for a cell. Using this constant as the type parameter for the DataAccess.getMemberMetadata method returns a ViewStyleHandle.

See Also:
ViewStyleHandle, Constant Field Values

METADATA_DRILLPATHS

public static final java.lang.String METADATA_DRILLPATHS
Returns List of valid DrillPathMetadata instances.

See Also:
DrillPathMetadata, Constant Field Values

METADATA_CURDRILLPATH

public static final java.lang.String METADATA_CURDRILLPATH
Returns String ID of the current Drill Path.

See Also:
Constant Field Values

METADATA_CURDRILLTARGET

public static final java.lang.String METADATA_CURDRILLTARGET
Returns String ID of current Drill Target for the current Drill Path

See Also:
Constant Field Values

METADATA_DATATYPE

public static final java.lang.String METADATA_DATATYPE
Measure data type information. If the member is not a measure, then the value is null.

See Also:
Constant Field Values

METADATA_QUERYPARENT

public static final java.lang.String METADATA_QUERYPARENT
See Also:
Constant Field Values

METADATA_CHILDCOUNT

public static final java.lang.String METADATA_CHILDCOUNT
See Also:
Constant Field Values

METADATA_HIERARCHY

public static final java.lang.String METADATA_HIERARCHY
Returns String ID of the member's hierarchy, if any. This returns null for members who are not part of a hierarchy or part of a hierarchical layer.

See Also:
Constant Field Values

METADATA_IS_CALCULATED_MEMBER

public static final java.lang.String METADATA_IS_CALCULATED_MEMBER
Is the specified member a calculated member? A return value of true indicates that it is.

See Also:
Constant Field Values

METADATA_RAWVALUE

public static final java.lang.String METADATA_RAWVALUE
Deprecated. Deprecated since 11.1.1.4.0. See (@link METADATA_DATAVALUE)
The raw key of the OLAP dimension member. The getMemberMetadata method returns a String when you use this constant for its type parameter.

See Also:
Constant Field Values

METADATA_EXTENT

public static final java.lang.String METADATA_EXTENT
The extent of the member, expressed in terms of data slices.

See Also:
Constant Field Values

METADATA_START

public static final java.lang.String METADATA_START
The starting slice of the member.

See Also:
Constant Field Values

METADATA_SORT_ATTR

public static final java.lang.String METADATA_SORT_ATTR
An attribute used for sorting in a header, for example. This could be a raw date for a date type column, or a unique key, or the long label, etc.

See Also:
Constant Field Values
Constructor Detail

MetadataMap

public MetadataMap()
Constructor for an empty map.


MetadataMap

public MetadataMap(java.util.Enumeration types)
Constructor that initializes the map from an Enumeration.

Parameters:
types - An Enumeration of types for this cursor.

MetadataMap

public MetadataMap(java.lang.String[] availableTypes)
Constructor that initializes the map from an array.

Parameters:
availableTypes - An array of types for this cursor.

MetadataMap

public MetadataMap(java.lang.String type)
Constructor that initializes the map with one type.

Parameters:
type - The type to put in this map.

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.4.0)

E12063-05

Copyright © 1997, 2011, Oracle. All rights reserved.