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

This class 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.

Since:

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

See Also:

Serialized Form

Constructor Summary

DataCellRange(DataCellKey key)
This constructor creates a range consisting of a single datacell.

DataCellRange(DataCellKey startKey, DataCellKey endKey)
This constructor creates a rectangular range, spanning one or more rows and one or more columns.

Method Summary

boolean	equals(java.lang.Object object) If object is not a DataCellRange, this method returns false.
DataCellIndex	getEndIndex() Deprecated.
DataCellIndex	getEndIndex(DataModel model) This method returns the endIndex of a multi-cell range, or null for a single-cell range.
DataCellKey	getEndKey()
DataCellIndex	getStartIndex() Deprecated.
DataCellIndex	getStartIndex(DataModel model) This method returns the startIndex of a multi-cell range, or the index of a single-cell range.
DataCellKey	getStartKey()
int	hashCode()
boolean	isSingleCell()
void	setEndIndex(DataCellIndex endIndex) Deprecated.
void	setStartIndex(DataCellIndex startIndex) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataCellRange

public DataCellRange(DataCellKey key)

This constructor creates a range consisting of a single datacell.

DataCellRange

public DataCellRange(DataCellKey startKey,
                     DataCellKey endKey)

This constructor creates a rectangular range, 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. If startKey.equals(endKey), a single-cell range is constructed, exactly as if the single-argument constructor had been called.

Method Detail

getStartKey

public DataCellKey getStartKey()

Returns:

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

getEndKey

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

getStartIndex

public DataCellIndex getStartIndex()

Deprecated.

This method is deprecated. Please use getStartIndex(DataModel) instead.

getEndIndex

public DataCellIndex getEndIndex()

Deprecated.

This method is deprecated. Please use getEndIndex(DataModel) instead.

setStartIndex

public void setStartIndex(DataCellIndex startIndex)

Deprecated.

This method is deprecated and should not be used.

setEndIndex

public void setEndIndex(DataCellIndex endIndex)

Deprecated.

This method is deprecated and should not be used.

equals

public boolean equals(java.lang.Object object)

If object is not a DataCellRange, this method returns false. Otherwise, if both ranges are single-cell ranges whose startKeys are equal, this method returns true. Otherwise, if both ranges are multi-cell ranges whose startKeys are equal and whose endKeys are equal, this method returns true. Otherwise this method returns false. This method ignores the startIndex and endIndex, since they are at best redundant and at worst not set or out of date.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object