oracle.dss.util
Interface DrillPathMetadata

public interface DrillPathMetadata

Implemented by an Object containing a collection of available Drill Targets (DrillTargetMetadata object instances). The DrillPathMetadata may be thought of as a hierarchy, for example.

Field Summary

static int	DRILLPATH_HIERARCHY Indicates that the DrillPathMetadata item represents a set of levels in a hierarchy.
static int	DRILLPATH_RELATED_ITEM Indicates that the DrillPathMetadata item represents a set of related items.

Method Summary

java.util.List	getDrillTargets() Return a list of DrillTargetMetadata objects available for this drill path.
java.lang.String	getID() Return the metadata ID of this DrillPathMetadata item.
java.lang.String	getLabel() Return the label of this DrillPathMetadata item corresponding to the ID.
int	getType() Return the type of this DrillPathMetadata item corresponding to the ID.

Field Detail

DRILLPATH_HIERARCHY

static final int DRILLPATH_HIERARCHY

Indicates that the DrillPathMetadata item represents a set of levels in a hierarchy. A list of DrillPathMetadata items associated with a particular Member or Layer may include several DrillPathMetadata items of this type.

See Also:

MetadataMap.METADATA_DRILLPATHS, LayerMetadataMap.LAYER_METADATA_DRILLPATHS, Constant Field Values

DRILLPATH_RELATED_ITEM

static final int DRILLPATH_RELATED_ITEM

Indicates that the DrillPathMetadata item represents a set of related items. A list of DrillPathMetadata items associated with a particular Member or Layer is expected to include no more than one DrillPathMetadata item of this type.

See Also:

MetadataMap.METADATA_DRILLPATHS, LayerMetadataMap.LAYER_METADATA_DRILLPATHS, Constant Field Values

Method Detail

getID

java.lang.String getID()

Return the metadata ID of this DrillPathMetadata item.

Returns:

a String representing the metadata ID of the drill path

getLabel

java.lang.String getLabel()

Return the label of this DrillPathMetadata item corresponding to the ID.

Returns:

a String representing the label of the drill path.

getType

int getType()

Return the type of this DrillPathMetadata item corresponding to the ID.

Returns:

a flag representing the type of this DrillPathMetadata item.

See Also:

DRILLPATH_HIERARCHY, DRILLPATH_RELATED_ITEM

getDrillTargets

java.util.List getDrillTargets()

Return a list of DrillTargetMetadata objects available for this drill path. The list of DrillTargetMetadata objects is assumed to be complete and ordered from most aggregated to detail levels.

Returns:

a List of available DrillTargetMetadata objects.