public class MetadataMap extends AbstractMap
Modifier and Type | Field and Description |
---|---|
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. |
MAP_TYPE_NOT_FOUND
Constructor and Description |
---|
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.
|
addType, clone, containsType, getTypeAt, isSuperset, merge, removeType, types
add, add, addAll, addAll, addElement, capacity, clear, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize
public static final java.lang.String METADATA_VALUE
getMemberMetadata
method returns a
String
when you use this constant for its
type
parameter.public static final java.lang.String METADATA_DISPLAYNAME
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.public static final java.lang.String METADATA_LONGLABEL
getMemberMetadata
method returns a
String
when you use this constant for its
type
parameter..public static final java.lang.String METADATA_SHORTLABEL
getMemberMetadata
method returns a
String
when you use this constant for its
type
parameter.public static final java.lang.String METADATA_INDENT
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
.public static final java.lang.String METADATA_DRILLSTATE
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.public static final java.lang.String METADATA_PARENT
public static final java.lang.String METADATA_PARENT_LEVEL
public static final java.lang.String METADATA_DRILL_PARENT_LONGLABEL
getMemberMetadata
method returns a
String
when you use this constant for
its type
parameter.public static final java.lang.String METADATA_DRILL_PARENT_SHORTLABEL
getMemberMetadata
method returns a
String
when you use this constant for
its type
parameter.public static final java.lang.String METADATA_DRILL_PARENT_DATE
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
.public static final java.lang.String METADATA_DRILL_PARENT_DATESPAN
public static final java.lang.String METADATA_REL_INDENT
getMemberMetadata
method returns an
Integer
when you use this constant as its
type
parameter.public static final java.lang.String METADATA_LEVEL
type
parameter,
the DataAccess.getMemberMetadata
method returns a
String
.public static final java.lang.String METADATA_LEVEL_LABEL
type
parameter,
the DataAccess.getMemberMetadata
method returns a
String
.public static final java.lang.String METADATA_LEVEL_NAME
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
.public static final java.lang.String METADATA_ISTOTAL
true
indicates that it is.public static final java.lang.String METADATA_AGGTYPE
public static final java.lang.String METADATA_ISAGG
true
indicates that it is. Primarily used for differentiating members
for formatting.public static final java.lang.String METADATA_DATE
Date
object.
When you pass this constant as the type
parameter,
the DataAccess.getMemberMetadata
method returns a
java.sql.Date
.public static final java.lang.String METADATA_DATESPAN
public static final java.lang.String METADATA_POSITION
getMemberMetadata
method returns an
int
when you use this constant as its
type
parameter.public static final java.lang.String METADATA_RELHIERINFO
getMemberMetadata
method returns a
String
when you use this constant as its
type
parameter.public static final java.lang.String METADATA_VALUE_RAW
public static final java.lang.String METADATA_DATAVALUE
public static final java.lang.String METADATA_UNIQUE_VALUE
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.public static final java.lang.String METADATA_MEDIUMLABEL
getMemberMetadata
method returns a
String
when you use this constant for its
type
parameter.public static final java.lang.String METADATA_FORMAT
getMemberMetadata
method returns a
String
when you use this constant as its
type
parameter.public static final java.lang.String METADATA_UNIQUE_PARENT
public static final java.lang.String METADATA_DRILL_PARENT_MEDIUMLABEL
getMemberMetadata
method returns a
String
when you use this constant for
its type
parameter.public static final java.lang.String METADATA_VIEWSTYLE
ViewStyle
that provides style property
settings for a cell.
Using this constant as the type
parameter for the
DataAccess.getMemberMetadata
method returns a
ViewStyleHandle
.ViewStyleHandle
,
Constant Field Valuespublic static final java.lang.String METADATA_DRILLPATHS
DrillPathMetadata
instances.DrillPathMetadata
,
Constant Field Valuespublic static final java.lang.String METADATA_CURDRILLPATH
public static final java.lang.String METADATA_CURDRILLTARGET
public static final java.lang.String METADATA_DATATYPE
null
.public static final java.lang.String METADATA_QUERYPARENT
public static final java.lang.String METADATA_CHILDCOUNT
public static final java.lang.String METADATA_HIERARCHY
public static final java.lang.String METADATA_IS_CALCULATED_MEMBER
true
indicates that it is.public static final java.lang.String METADATA_RAWVALUE
getMemberMetadata
method returns a
String
when you use this constant for its
type
parameter.public static final java.lang.String METADATA_EXTENT
public static final java.lang.String METADATA_START
public static final java.lang.String METADATA_SORT_ATTR
public MetadataMap()
public MetadataMap(java.util.Enumeration types)
types
- An Enumeration of types for this cursor.public MetadataMap(java.lang.String[] availableTypes)
availableTypes
- An array of types for this cursor.public MetadataMap(java.lang.String type)
type
- The type to put in this map.