oracle.adf.view.faces.bi.component.pivotTable

Class CellRange

java.lang.Object

oracle.adf.view.faces.bi.component.pivotTable.CellRange

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DataCellRange, HeaderCellRange

public abstract class CellRange
extends java.lang.Object
implements java.io.Serializable

A range of Pivot Table cells. The selection in a Pivot Table is a set of CellRanges.

Since:

release specific (what release of product did this appear in)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CellRange() Sole constructor.

Method Summary

Modifier and Type	Method and Description
CellIndex	getEndIndex(DataModel model) Returns the end index of a multi-cell range, or null for a single-cell range.
CellKey	getEndKey() Returns the end key of a multi-cell range, or null for a single-cell range All subclasses are required to override the implementation in this superclass, which throws UnsupportedOperationException.
CellIndex	getStartIndex(DataModel model) Returns the start index of a multi-cell range, or the index of a single-cell range.
CellKey	getStartKey() Returns the start key of a multi-cell range, or the key of a single-cell range.
boolean	isSingleCell() Indicates whether this range consists of a single cell or multiple cells.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CellRange

public CellRange()

Sole constructor.

Method Detail

getStartKey

public CellKey getStartKey()

Returns the start key of a multi-cell range, or the key of a single-cell range. All subclasses are required to override the implementation in this superclass, which throws UnsupportedOperationException.

Returns:

the start key of a multi-cell range, or the key of a single-cell range

getEndKey

public CellKey getEndKey()

Returns the end key of a multi-cell range, or null for a single-cell range All subclasses are required to override the implementation in this superclass, which throws UnsupportedOperationException.

Returns:

the end key of a multi-cell range, or null for a single-cell range

isSingleCell

public boolean isSingleCell()

Indicates whether this range consists of a single cell or multiple cells. All subclasses are required to override the implementation in this superclass, which throws UnsupportedOperationException.

Returns:

true if this range consists of a single cell; false otherwise.

getStartIndex

public CellIndex getStartIndex(DataModel model)

Returns the start index of a multi-cell range, or the index of a single-cell range. If that index hasn't previously been set (whether in the constructor, or via a previous call to getStartIndex, or internally by the Pivot Table), this method computes the start index from the start key, stores that index for future use, and returns that index. Thus, the first call to this method can be expensive. All subclasses are required to override the implementation in this superclass, which throws UnsupportedOperationException.

Returns:

the start index of a multi-cell range, or the index of a single-cell range

getEndIndex

public CellIndex getEndIndex(DataModel model)

Returns the end index of a multi-cell range, or null for a single-cell range. If that index hasn't previously been set (whether in the constructor, or via a previous call to getEndIndex, or internally by the Pivot Table), this method computes the end index from the end key, stores that index for future use, and returns that index. Thus, the first call to this method can be expensive. All subclasses are required to override the implementation in this superclass, which throws UnsupportedOperationException.

Returns:

the end index of a multi-cell range, or null for a single-cell range