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

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

All Implemented Interfaces:

java.io.Serializable

public class DataCellRange
extends CellRange

Represents the rectangular range of datacells from the specified start cell at the top left to the specified end cell at the bottom right, inclusive. (In RTL, the start cell is at the top right, and the end cell is at the bottom left.)

Since:

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

See Also:

Serialized Form

Constructor Summary

DataCellRange(DataCellKey key)
Creates a single-cell range (a range consisting of a single datacell).

DataCellRange(DataCellKey startKey, DataCellIndex startIndex, DataCellKey endKey, DataCellIndex endIndex)
Creates a rectangular range of datacells, spanning one or more rows and one or more columns.

DataCellRange(DataCellKey startKey, DataCellKey endKey)
Deprecated. This constructor can have severe performance consequences. Use the 4-arg constructor instead.

Method Summary

boolean	equals(java.lang.Object object) Indicates whether the specified object is equal to this range.
DataCellIndex	getEndIndex() Deprecated. Please use getEndIndex(DataModel) instead.
DataCellIndex	getEndIndex(DataModel model) Returns the end index of a multi-cell range, or null for a single-cell range.
DataCellKey	getEndKey() Returns the end key of a multi-cell range, or null for a single-cell range
DataCellIndex	getStartIndex() Deprecated. Please use getStartIndex(DataModel) instead.
DataCellIndex	getStartIndex(DataModel model) Returns the start index of a multi-cell range, or the index of a single-cell range.
DataCellKey	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.
void	setEndIndex(DataCellIndex endIndex) Deprecated. Do not use.
void	setStartIndex(DataCellIndex startIndex) Deprecated. Do not use.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataCellRange

public DataCellRange(DataCellKey key)

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

Parameters:

key - the key of the datacell to include in this range

DataCellRange

@Deprecated
public DataCellRange(DataCellKey startKey,
                                DataCellKey endKey)

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

Creates a rectangular range of datacells. 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 datacell in this range, inclusive

endKey - the key of the last datacell in this range, inclusive

DataCellRange

public DataCellRange(DataCellKey startKey,
                     DataCellIndex startIndex,
                     DataCellKey endKey,
                     DataCellIndex endIndex)

Creates a rectangular range of datacells, spanning one or more rows and one or more columns. The startKey and endKey indicate the top left and bottom right datacells in the range, inclusive. (In RTL, the start cell is at the top right, and the end cell is at the bottom left.) 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 datacell in this range, inclusive

startIndex - the index of the first datacell in this range, inclusive

endKey - the key of the last datacell in this range, inclusive

endIndex - the index of the last datacell in this range, inclusive

Method Detail

getStartKey

public DataCellKey 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 DataCellKey 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 DataCellIndex 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 DataCellIndex 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

getStartIndex

@Deprecated
public DataCellIndex getStartIndex()

Deprecated. Please use getStartIndex(DataModel) instead.

Returns the start index.

getEndIndex

@Deprecated
public DataCellIndex getEndIndex()

Deprecated. Please use getEndIndex(DataModel) instead.

Returns the end index.

setStartIndex

@Deprecated
public void setStartIndex(DataCellIndex startIndex)

Deprecated. Do not use.

setEndIndex

@Deprecated
public void setEndIndex(DataCellIndex endIndex)

Deprecated. Do not use.

equals

public boolean equals(java.lang.Object object)

Indicates whether the specified object is equal to this range. If object is not a DataCellRange, 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 DataCellRange object; false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object