oracle.dss.util

Class LayerMetadataMap

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.Vector

oracle.dss.util.AbstractMap

oracle.dss.util.LayerMetadataMap

All Implemented Interfaces:

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

public class LayerMetadataMap
extends AbstractMap

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LAYER_METADATA_CANPIVOT Indicates whether the layer can be pivoted anywhere.
static java.lang.String	LAYER_METADATA_CURDRILLPATH Returns String ID of current Drill Path
static java.lang.String	LAYER_METADATA_CURDRILLTARGET Returns String ID of current Drill Target for the current Drill Path
static java.lang.String	LAYER_METADATA_DISPLAYNAME Layer's display name (which is distinct from the ID that is found in LAYER_METADATA_NAME).
static java.lang.String	LAYER_METADATA_DRILLPATHS Returns List of valid DrillPathMetadata instances.
static java.lang.String	LAYER_METADATA_DRILLSTATE Value that indicates the type of drill available and its icon.
static java.lang.String	LAYER_METADATA_HIERARCHICAL If this constant is supported by the DataAccess, then getLayerMetadata returns true for this constant if at least one member in the layer is drillable (i.e.
static java.lang.String	LAYER_METADATA_LONGLABEL Long label for the layer name.
static java.lang.String	LAYER_METADATA_LONGLABEL_PLURAL Plural long label for the layer name.
static java.lang.String	LAYER_METADATA_MAX_LEVEL Maximum level possible for the given layer.
static java.lang.String	LAYER_METADATA_MEASURE Is the layer the measure layer?
static java.lang.String	LAYER_METADATA_MEDIUMLABEL Medium label for the layer name.
static java.lang.String	LAYER_METADATA_NAME Unique ID for a layer.
static java.lang.String	LAYER_METADATA_SHORTLABEL Short label for the layer name.
static java.lang.String	LAYER_METADATA_SHORTLABEL_PLURAL Plural short label for the layer name.
static java.lang.String	LAYER_METADATA_VIEWSTYLE A handle to the ViewStyle that provides style property settings for a layer.

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

Constructors

Constructor and Description
LayerMetadataMap() Constructor for an empty map.
LayerMetadataMap(java.util.Enumeration availableTypes) Constructor that initializes the map from an Enumeration.
LayerMetadataMap(java.lang.String type) Constructor that initializes the map with one type.
LayerMetadataMap(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, forEach, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeIf, removeRange, replaceAll, retainAll, set, setElementAt, setSize, size, sort, spliterator, subList, toArray, toArray, toString, trimToSize

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

LAYER_METADATA_NAME

public static final java.lang.String LAYER_METADATA_NAME

Unique ID for a layer.

See Also:

Constant Field Values

LAYER_METADATA_DISPLAYNAME

public static final java.lang.String LAYER_METADATA_DISPLAYNAME

Layer's display name (which is distinct from the ID that is found in LAYER_METADATA_NAME).

See Also:

Constant Field Values

LAYER_METADATA_LONGLABEL

public static final java.lang.String LAYER_METADATA_LONGLABEL

Long label for the layer name.

See Also:

Constant Field Values

LAYER_METADATA_SHORTLABEL

public static final java.lang.String LAYER_METADATA_SHORTLABEL

Short label for the layer name.

See Also:

Constant Field Values

LAYER_METADATA_MEASURE

public static final java.lang.String LAYER_METADATA_MEASURE

Is the layer the measure layer?

See Also:

Constant Field Values

LAYER_METADATA_HIERARCHICAL

public static final java.lang.String LAYER_METADATA_HIERARCHICAL

If this constant is supported by the DataAccess, then getLayerMetadata returns true for this constant if at least one member in the layer is drillable (i.e. its DRILLSTATE is DRILLABLE or IS_DRILLED). Returns false otherwise, or null if not supported.

See Also:

Constant Field Values

LAYER_METADATA_CANPIVOT

public static final java.lang.String LAYER_METADATA_CANPIVOT

Indicates whether the layer can be pivoted anywhere. That is, indicates whether anything can be pivoted to (or next to) the layer. Returns 0 if no, 1 if yes.

See Also:

Constant Field Values

LAYER_METADATA_LONGLABEL_PLURAL

public static final java.lang.String LAYER_METADATA_LONGLABEL_PLURAL

Plural long label for the layer name.

See Also:

Constant Field Values

LAYER_METADATA_SHORTLABEL_PLURAL

public static final java.lang.String LAYER_METADATA_SHORTLABEL_PLURAL

Plural short label for the layer name.

See Also:

Constant Field Values

LAYER_METADATA_DRILLPATHS

public static final java.lang.String LAYER_METADATA_DRILLPATHS

Returns List of valid DrillPathMetadata instances.

See Also:

DrillPathMetadata, Constant Field Values

LAYER_METADATA_DRILLSTATE

public static final java.lang.String LAYER_METADATA_DRILLSTATE

Value that indicates the type of drill available and its icon. Use this constant as the type parameter for the getLayerMetadata method to retrieve a constant that describes whether the layer has been drilled or can be drilled. The drill state constants are listed in the See Also section.

See Also:

DataDirector.DRILLSTATE_DRILLABLE, DataDirector.DRILLSTATE_IS_DRILLED, DataDirector.DRILLSTATE_NOT_DRILLABLE, Constant Field Values

LAYER_METADATA_MEDIUMLABEL

public static final java.lang.String LAYER_METADATA_MEDIUMLABEL

Medium label for the layer name.

See Also:

Constant Field Values

LAYER_METADATA_CURDRILLPATH

public static final java.lang.String LAYER_METADATA_CURDRILLPATH

Returns String ID of current Drill Path

See Also:

Constant Field Values

LAYER_METADATA_CURDRILLTARGET

public static final java.lang.String LAYER_METADATA_CURDRILLTARGET

Returns String ID of current Drill Target for the current Drill Path

See Also:

Constant Field Values

LAYER_METADATA_VIEWSTYLE

public static final java.lang.String LAYER_METADATA_VIEWSTYLE

A handle to the ViewStyle that provides style property settings for a layer. A layer includes the label for the pivot handle, if the label is visible. Using this constant as the type parameter for the DataAccess.getLayerMetadata method returns a ViewStyleHandle.

See Also:

ViewStyleHandle, oracle.dss.crosstab.Crosstab#setPivotLabelVisible, Constant Field Values

LAYER_METADATA_MAX_LEVEL

public static final java.lang.String LAYER_METADATA_MAX_LEVEL

Maximum level possible for the given layer. This is used when rendering headers as a single layer, but with a "multi-layer" look, so the renderer knows how much width or height to allocate for the header without reading ahead on members it does not want to render right away.

See Also:

Constant Field Values

Constructor Detail

LayerMetadataMap

public LayerMetadataMap()

Constructor for an empty map.

LayerMetadataMap

public LayerMetadataMap(java.lang.String[] availableTypes)

Constructor that initializes the map from an array.

Parameters:

availableTypes - An array of types for this cursor.

LayerMetadataMap

public LayerMetadataMap(java.lang.String type)

Constructor that initializes the map with one type.

Parameters:

type - The type to put in this map.

LayerMetadataMap

public LayerMetadataMap(java.util.Enumeration availableTypes)

Constructor that initializes the map from an Enumeration.

Parameters:

availableTypes - An Enumeration of types for this cursor.