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

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractSet<E>
          java.util.HashSet<E>
              java.util.LinkedHashSet<E>
                  oracle.adf.view.faces.bi.component.pivotTable.SelectionSet<HeaderCellRange>
                      oracle.adf.view.faces.bi.component.pivotTable.HeaderCellSelectionSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<HeaderCellRange>, java.util.Collection<HeaderCellRange>, java.util.Set<HeaderCellRange>

public class HeaderCellSelectionSet
extends SelectionSet<HeaderCellRange>

Since:

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

See Also:

Serialized Form

Constructor Summary

HeaderCellSelectionSet(int edge)

Method Summary

java.util.Iterator<HeaderCellIndex>	cellIndexIterator() There is no guarantee as to the order in which cells are returned by this iterator.
java.util.Iterator<HeaderCellKey>	cellKeyIterator() There is no guarantee as to the order in which cells are returned by this iterator.
int	getEdge() Returns the edge ( DataDirector.ROW_EDGE or DataDirector.COLUMN_EDGE ) to which this HeaderCellSelectionSet corresponds.
int	getLayer() Returns the index of the startLayer of all the ranges in this set, or -1 if the set is empty or if the layer is unknown at this time.

Methods inherited from class oracle.adf.view.faces.bi.component.pivotTable.SelectionSet

getDataModel, getPivotTableModel, setDataModel, setPivotTableModel

Methods inherited from class java.util.HashSet

add, clear, clone, contains, isEmpty, iterator, remove, size

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Constructor Detail

HeaderCellSelectionSet

public HeaderCellSelectionSet(int edge)

Method Detail

cellKeyIterator

public java.util.Iterator<HeaderCellKey> cellKeyIterator()
                                                  throws DataException

There is no guarantee as to the order in which cells are returned by this iterator. Also, if an individual cell appears in multiple ranges of the selection, there is no guarantee whether it will be returned once or multiple times. It is possible that guarantees for one or both of these things will be provided in the future.

Returns:

an iterator over every cellKey in every range of the SelectionSet

Throws:

DataException

cellIndexIterator

public java.util.Iterator<HeaderCellIndex> cellIndexIterator()
                                                      throws DataException

There is no guarantee as to the order in which cells are returned by this iterator. Also, if an individual cell appears in multiple ranges of the selection, there is no guarantee whether it will be returned once or multiple times. It is possible that guarantees for one or both of these things will be provided in the future.

Returns:

an iterator over every cellKey in every range of the SelectionSet

Throws:

DataException

getEdge

public int getEdge()

Returns the edge ( DataDirector.ROW_EDGE or DataDirector.COLUMN_EDGE ) to which this HeaderCellSelectionSet corresponds.

Returns:

the edge for this HeaderCellSelectionSet

getLayer

public int getLayer()

Returns the index of the startLayer of all the ranges in this set, or -1 if the set is empty or if the layer is unknown at this time.

Returns:

the layer index or -1