oracle.dss.util
Class DataMap

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.Vector
              oracle.dss.util.AbstractMap
                  oracle.dss.util.DataMap

All Implemented Interfaces:

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

public class DataMap
extends AbstractMap

See Also:

Serialized Form

Field Summary

static java.lang.String	DATA_AGG_COLLECTION Get list of column/value pairs representing the post-cube aggregation for the given cell, if any
static java.lang.String	DATA_AGGREGATES Get list of column/value pairs representing the aggregation for the given cell, if any.
static java.lang.String	DATA_AGGTYPE Returns the aggregation type for the cell, if it is an agg.
static java.lang.String	DATA_ANNOTATION An annotation for a data value.
static java.lang.String	DATA_CUBE_MAXIMUM Return the cube maximum for the measure represented by the given cell location
static java.lang.String	DATA_CUBE_MINIMUM Return the cube minimum for the measure represented by the given cell location
static java.lang.String	DATA_FORMATTED Formatted data.
static java.lang.String	DATA_FORMATTED_VALUE Formatted data value.
static java.lang.String	DATA_GROUPSORT Whether a cell is involved in a table group sort, and if so, where the cell is located (at the start, at the end, or in the middle of the sort).
static java.lang.String	DATA_IS_EDITABLE Is this cell editable (for write back)?
static java.lang.String	DATA_ISTOTAL Whether the data in the cell is a total.
static java.lang.String	DATA_KEYPATH The physical key path, if available Using this constant as the type parameter for the DataAccess.getValue method retrieves the underlying key path for Models based on ADF bindings
static java.lang.String	DATA_NAME Unique name in the database for a specified table cell.
static java.lang.String	DATA_RATIO The percentage of the width of the column to paint a graphic bar in a cell in a table or pivot table.
static java.lang.String	DATA_ROWKEY The physical row key, if available Using this constant as the type parameter for the DataAccess.getValue method retrieves the underlying row key for Models based on ADF bindings
static java.lang.String	DATA_TYPE A data type of a specified value in the database.
static java.lang.String	DATA_UNFORMATTED Unformatted data.
static java.lang.String	DATA_VALUE Unformatted data value.
static java.lang.String	DATA_VIEWFORMAT A handle to the ViewFormat that provides number-formatting property settings for a cell.
static java.lang.String	DATA_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

DataMap()
Constructor for an empty data map.

DataMap(java.util.Enumeration availableTypes)
Constructor that initializes the map from an Enumeration.

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

DataMap(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

DATA_RATIO

public static final java.lang.String DATA_RATIO

The percentage of the width of the column to paint a graphic bar in a cell in a table or pivot table. Using this constant as the type parameter for the DataAccess.getValue method returns a Float. You can set rules to display bars in cells.

Note that graphical bars work with positive ratios only.

See Also:

Constant Field Values

DATA_GROUPSORT

public static final java.lang.String DATA_GROUPSORT

Whether a cell is involved in a table group sort, and if so, where the cell is located (at the start, at the end, or in the middle of the sort). This data map type is used for repeating group sort labels during printing when the sort is broken across multiple physical pages.

Using this constant as the type parameter for the DataAccess.getValue method retrieves a value that is represented by one of the DataDirector constants that begin with GROUPSORT_.

See Also:

DataDirector.GROUPSORT_NONE, DataDirector.GROUPSORT_START, DataDirector.GROUPSORT_MIDDLE, DataDirector.GROUPSORT_END, Constant Field Values

DATA_NAME

public static final java.lang.String DATA_NAME

Unique name in the database for a specified table cell. Using this constant as the type parameter for the DataAccess.getValue method retrieves the metadata value that the table cell contains.

See Also:

Constant Field Values

DATA_FORMATTED

public static final java.lang.String DATA_FORMATTED

Formatted data. This constant is equivalent to DATA_FORMATTED_VALUE. The DataAccess.getValue method usually returns a String when you use this constant as its type parameter.

See Also:

Constant Field Values

DATA_FORMATTED_VALUE

public static final java.lang.String DATA_FORMATTED_VALUE

Formatted data value. The DataAccess.getValue method usually returns a String when you use this constant as its type parameter.

See Also:

Constant Field Values

DATA_UNFORMATTED

public static final java.lang.String DATA_UNFORMATTED

Unformatted data. This constant is equivalent to DATA_VALUE. Using this constant as the type parameter for the DataAccess.getValue method retrieves unformatted data for a specified data value.

See Also:

Constant Field Values

DATA_VALUE

public static final java.lang.String DATA_VALUE

Unformatted data value. Using this constant as the type parameter for the DataAccess.getValue method retrieves unformatted data for a specified data value.

See Also:

Constant Field Values

DATA_TYPE

public static final java.lang.String DATA_TYPE

A data type of a specified value in the database. Using this constant as the type parameter for the DataAccess.getValue method retrieves the data type of a specified data value.

See Also:

Constant Field Values

DATA_VIEWSTYLE

public static final java.lang.String DATA_VIEWSTYLE

A handle to the ViewStyle that provides style property settings for a cell. Using this constant as the type parameter for the DataAccess.getValue method returns a ViewStyleHandle.

See Also:

ViewStyleHandle, Constant Field Values

DATA_VIEWFORMAT

public static final java.lang.String DATA_VIEWFORMAT

A handle to the ViewFormat that provides number-formatting property settings for a cell. Using this constant as the type parameter for the DataAccess.getValue method returns a ViewFormatHandle.

See Also:

ViewFormatHandle, Constant Field Values

DATA_ANNOTATION

public static final java.lang.String DATA_ANNOTATION

An annotation for a data value. Using this constant as the type parameter for the DataAccess.getValue method retrieves an annotation for a specified data value.

See Also:

Constant Field Values

DATA_ISTOTAL

public static final java.lang.String DATA_ISTOTAL

Whether the data in the cell is a total. Using this constant as the type parameter for the DataAccess.getValue method retrieves "true" if the data value is a total.

See Also:

Constant Field Values

DATA_AGGTYPE

public static final java.lang.String DATA_AGGTYPE

Returns the aggregation type for the cell, if it is an agg. Depending on the implementation, this may return null or an agg type of none if no aggregate is present.

See Also:

Constant Field Values

DATA_ROWKEY

public static final java.lang.String DATA_ROWKEY

The physical row key, if available Using this constant as the type parameter for the DataAccess.getValue method retrieves the underlying row key for Models based on ADF bindings

See Also:

Constant Field Values

DATA_KEYPATH

public static final java.lang.String DATA_KEYPATH

The physical key path, if available Using this constant as the type parameter for the DataAccess.getValue method retrieves the underlying key path for Models based on ADF bindings

See Also:

Constant Field Values

DATA_IS_EDITABLE

public static final java.lang.String DATA_IS_EDITABLE

Is this cell editable (for write back)?

See Also:

Constant Field Values

DATA_CUBE_MINIMUM

public static final java.lang.String DATA_CUBE_MINIMUM

Return the cube minimum for the measure represented by the given cell location

See Also:

Constant Field Values

DATA_CUBE_MAXIMUM

public static final java.lang.String DATA_CUBE_MAXIMUM

Return the cube maximum for the measure represented by the given cell location

See Also:

Constant Field Values

DATA_AGGREGATES

public static final java.lang.String DATA_AGGREGATES

Get list of column/value pairs representing the aggregation for the given cell, if any.

See Also:

Constant Field Values

DATA_AGG_COLLECTION

public static final java.lang.String DATA_AGG_COLLECTION

Get list of column/value pairs representing the post-cube aggregation for the given cell, if any

See Also:

Constant Field Values

Constructor Detail

DataMap

public DataMap()

Constructor for an empty data map.

DataMap

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

Constructor that initializes the map from an array.

Parameters:

availableTypes - An array of types for this data cursor.

DataMap

public DataMap(java.lang.String type)

Constructor that initializes the map with one type.

Parameters:

type - The type to put in this map.

DataMap

public DataMap(java.util.Enumeration availableTypes)

Constructor that initializes the map from an Enumeration.

Parameters:

availableTypes - An Enumeration of types for this data cursor.