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

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

Constructors

Constructor and Description
HeaderCellRange(HeaderCellKey key) Creates a single-cell range (a range consisting of a single header cell).
HeaderCellRange(HeaderCellKey startKey, HeaderCellIndex startIndex, HeaderCellKey endKey, HeaderCellIndex endIndex) Creates a multi-cell range.
HeaderCellRange(HeaderCellKey startKey, HeaderCellKey endKey) Deprecated. This constructor can have severe performance consequences. Use the 4-arg constructor instead.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Indicates whether the specified object is equal to this range.
HeaderCellIndex	getEndIndex(DataModel model) Returns the end index of a multi-cell range, or null for a single-cell range.
HeaderCellKey	getEndKey() Returns the end key of a multi-cell range, or null for a single-cell range.
java.lang.Object	getPrivateData() For use by pivot table only.
HeaderCellIndex	getStartIndex(DataModel model) Returns the start index of a multi-cell range, or the index of a single-cell range.
HeaderCellKey	getStartKey() Returns the start key of a multi-cell range, or the key of a single-cell range.
int	hashCode()
boolean	isSingleCell() Indicates whether this range consists of a single cell or multiple cells.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderCellRange

public HeaderCellRange(HeaderCellKey key)

Creates a single-cell range (a range consisting of a single header cell).

Parameters:

key - the key of the header cell to include in this range

HeaderCellRange

@Deprecated
public HeaderCellRange(HeaderCellKey startKey,
                                   HeaderCellKey endKey)

Deprecated. This constructor can have severe performance consequences. Use the 4-arg constructor instead.

Creates a multi-cell range. Performance note: If the selection contains a multi-cell range for which the start and end indexes are not known, the Pivot Table must expensively walk the data source until they are found, in order to know which intervening cells are included in the range. Thus, it is important to use the constructor that takes indexes as well as keys, in preference to this deprecated constructor. Note that this issue does not apply to single-cell ranges.

Parameters:

startKey - the key of the first header cell in this range, inclusive

endKey - the key of the last header cell in this range, inclusive

HeaderCellRange

public HeaderCellRange(HeaderCellKey startKey,
                       HeaderCellIndex startIndex,
                       HeaderCellKey endKey,
                       HeaderCellIndex endIndex)

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. The start and end indexes should be the indexes corresponding to the start and end keys. Like the keys, they should not be null. The caller is advised to use this constructor only if it can obtain the required indexes cheaply.

Parameters:

startKey - the key of the first header cell in this range, inclusive

startIndex - the index of the first header cell in this range, inclusive

endKey - the key of the last header cell in this range, inclusive

endIndex - the index of the last header cell in this range, inclusive

Method Detail

getStartKey

public HeaderCellKey getStartKey()

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

Overrides:

getStartKey in class CellRange

Returns:

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

getEndKey

public HeaderCellKey getEndKey()

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

Overrides:

getEndKey in class CellRange

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.

Overrides:

isSingleCell in class CellRange

Returns:

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

getStartIndex

public HeaderCellIndex 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.

Overrides:

getStartIndex in class CellRange

Returns:

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

getEndIndex

public HeaderCellIndex 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.

Overrides:

getEndIndex in class CellRange

Returns:

the end index 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)

Indicates whether the specified object is equal to this range. If object is not a HeaderCellRange, this method returns false. Otherwise, if both ranges are single-cell ranges whose start keys are equal, this method returns true. Otherwise, if both ranges are multi-cell ranges whose start keys are equal and whose end keys are equal, this method returns true. Otherwise this method returns false. This method ignores the start index and end index, since they are at best redundant and at worst not set or out of date.

Overrides:

equals in class java.lang.Object

Parameters:

object - the object to test for equality

Returns:

true if the specified object is equal to this object; false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object