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

java.lang.Object
  oracle.adf.view.faces.bi.component.pivotTable.CellRange
      oracle.adf.view.faces.bi.component.pivotTable.HeaderCellRange

All Implemented Interfaces:

java.io.Serializable

public class HeaderCellRange
extends CellRange

This class represents the range of header cells from the specified start cell to the specified end cell, inclusive. Only header cells starting in the same layer can be selected together. Thus, the start and end cells must start in the same layer. If the range spans any header cells that do not start in that layer, those header cells are not part of the range.

Since:

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

See Also:

Serialized Form

Constructor Summary

HeaderCellRange(HeaderCellKey key)
This constructor creates a range consisting of a single header cell.

HeaderCellRange(HeaderCellKey startKey, HeaderCellKey endKey)
This constructor creates a multi-cell range.

Method Summary

boolean	equals(java.lang.Object object)
HeaderCellIndex	getEndIndex(DataModel model) This method returns the endIndex of a multi-cell range, or null for a single-cell range.
HeaderCellKey	getEndKey()
java.lang.Object	getPrivateData() For use by pivot table only.
HeaderCellIndex	getStartIndex(DataModel model) This method returns the startIndex of a multi-cell range, or the index of a single-cell range.
HeaderCellKey	getStartKey()
int	hashCode()
boolean	isSingleCell()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderCellRange

public HeaderCellRange(HeaderCellKey key)

This constructor creates a range consisting of a single header cell.

HeaderCellRange

public HeaderCellRange(HeaderCellKey startKey,
                       HeaderCellKey endKey)

This constructor creates a multi-cell range. The startKey and endKey indicate the first and last header cells in the range, inclusive. These header cells must start in the same layer. If startKey.equals(endKey), a single-cell range is constructed, exactly as if the single-argument constructor had been called.

Method Detail

getStartKey

public HeaderCellKey getStartKey()

Returns:

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

getEndKey

public HeaderCellKey getEndKey()

Returns:

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

isSingleCell

public boolean isSingleCell()

Returns:

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

getStartIndex

public HeaderCellIndex getStartIndex(DataModel model)

This method returns the startIndex of a multi-cell range, or the index of a single-cell range. If that index hasn't previously been set, either internally by the Pivot Table or via a previous call to getStartIndex(), 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.

Returns:

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

getEndIndex

public HeaderCellIndex getEndIndex(DataModel model)

This method returns the endIndex of a multi-cell range, or null for a single-cell range. If that index hasn't previously been set, either internally by the Pivot Table or via a previous call to getEndIndex(), 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.

Returns:

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

getPrivateData

public java.lang.Object getPrivateData()

For use by pivot table only. All other use is strictly unsupported.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object