oracle.dss.util
Class MetadataMap

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--java.util.AbstractList
              |
              +--java.util.Vector
                    |
                    +--oracle.dss.util.AbstractMap
                          |
                          +--oracle.dss.util.MetadataMap

All Implemented Interfaces:

java.lang.Cloneable, java.util.Collection, java.util.List, java.io.Serializable

public class MetadataMap

extends AbstractMap

List of the requested types of metadata for a cursor (that is, a DataAccess object. At each point in a cursor, several types of information may be available. This list identifies all the types of information that have been requested by any view that uses the cursor.

See Also:

Serialized Form

Field Summary

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_DRILLSTATE Value that indicates the type of drill available and its icon.
static java.lang.String	METADATA_FORMAT Number format.
static java.lang.String	METADATA_INDENT Number of levels to indent the dimension member.
static java.lang.String	METADATA_LEVEL The level name of which this item is a member.
static java.lang.String	METADATA_LEVEL_LABEL The level name (in a presentable format) of which this item is a member.
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_POSITION Position of a member within its hierarchical location.
static java.lang.String	METADATA_REL_INDENT Relative level indent number in the cursor for a given dimension (member's indent - minimum indent for any dimension member in the cursor).
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_VALUE The value of the dimension member, as it appears in the database.
static java.lang.String	METADATA_VIEWSTYLE The ViewStyle providing cell-level style property overrides.

Fields inherited from class oracle.dss.util.AbstractMap

MAP_TYPE_NOT_FOUND

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.

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, 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

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 value of the dimension member, as it appears in the database. The getMemberMetadata method returns a String when you use this constant for its type parameter.

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..

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.

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.

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.

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

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.

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.

METADATA_POSITION

public static final java.lang.String METADATA_POSITION

Position of a member within its hierarchical location.

METADATA_PARENT

public static final java.lang.String METADATA_PARENT

Parent dimension member of a member.

METADATA_REL_INDENT

public static final java.lang.String METADATA_REL_INDENT

Relative level indent number in the cursor for a given dimension (member's indent - minimum indent for any dimension member in the cursor).

METADATA_VIEWSTYLE

public static final java.lang.String METADATA_VIEWSTYLE

The ViewStyle providing cell-level style property overrides. When this type of metadata is requested through the DataAccess getMemberMetadata method, a ViewStyleHandle is returned.

See Also:

ViewStyleHandle

METADATA_LEVEL

public static final java.lang.String METADATA_LEVEL

The level name of which this item is a member. When this type of metadata is requested through the DataAccess getMemberMetadata method, a String is returned.

METADATA_LEVEL_LABEL

public static final java.lang.String METADATA_LEVEL_LABEL

The level name (in a presentable format) of which this item is a member. When this type of metadata is requested through the DataAccess getMemberMetadata method, a String is returned.

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.

METADATA_DATESPAN

public static final java.lang.String METADATA_DATESPAN

The span, in days, of the specified time dimension member.

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:

availableTypes - 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.