oracle.dss.util
Class EdgeComponentInfo

java.lang.Object
  |
  +--oracle.dss.util.ComponentInfo
        |
        +--oracle.dss.util.EdgeComponentInfo

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

TableEdgeComponentInfo

public class EdgeComponentInfo

extends ComponentInfo

Information about the location of a DataView component in an edge. Used for components that are associated with edges, such as a HeaderCell.

Constructor Summary

EdgeComponentInfo(int edge, int depth, int index)
Constructor.

Method Summary

java.lang.Object	clone() Clones this EdgeComponentInfo.
boolean	equals(java.lang.Object o) Indicates whether the specified object is equivalent to this EdgeComponentInfo.
int	getDepth() Retrieves the depth of the component.
int	getEdge() Retrieves the edge that the component is on.
int	getIndex() Retrieves the index of the component.
QDR	getQDR(DataAccess dataAccess, int flags) Retrieves a QDR for this EdgeComponentInfo.
void	setEdgeDepthIndex(int edge, int depth, int index) Specifies the edge, depth, and index of this EdgeComponentInfo.
java.lang.String	toString() Produces a String that identifies the edge, depth, and index of the component.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EdgeComponentInfo

public EdgeComponentInfo(int edge,
                         int depth,
                         int index)

Constructor.

Parameters:

edge - The edge that the component is on.

depth - The depth within edge. The depth identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.

index - The index of the dimension member that this component presents. The index is zero-based. Each dimension member in the innermost dimension has a unique index. In outer dimensions, any index that the outer dimension spans can be used.

Method Detail

setEdgeDepthIndex

public void setEdgeDepthIndex(int edge,
                              int depth,
                              int index)

Specifies the edge, depth, and index of this EdgeComponentInfo. This method allows reuse of this EdgeComponentInfo.

Parameters:

edge - The edge of the component for which you want to use this EdgeComponentInfo. Constants are defined in the DataDirector interface.

depth - The depth of the component. The depth identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.

index - The index of the component. The index is zero-based. Each dimension member in the innermost dimension has a unique index. In outer dimensions, any index that the outer dimension spans can be used.

clone

public java.lang.Object clone()

Clones this EdgeComponentInfo.

Overrides:

clone in class ComponentInfo

Returns:

The clone of this EdgeComponentInfo.

getEdge

public int getEdge()

Retrieves the edge that the component is on.

Returns:

A constant that represents the edge. Constants are defined in the DataDirector interface.

See Also:

DataDirector

getDepth

public int getDepth()

Retrieves the depth of the component. The depth identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.

Returns:

The depth of the component.

getIndex

public int getIndex()

Retrieves the index of the component.

Returns:

The index of the component. The index is zero-based. Each dimension member in the innermost dimension has a unique index. In outer dimensions, any index that the outer dimension spans can be used.

equals

public boolean equals(java.lang.Object o)

Indicates whether the specified object is equivalent to this EdgeComponentInfo. EdgeComponentInfo objects are equivalent if they refer to the same edge, depth, and index.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare with this EdgeComponentInfo.

Returns:

true if both objects refer to the same edge, depth, and index, false if not or if o is not an EdgeComponentInfo.

getQDR

public QDR getQDR(DataAccess dataAccess,
                  int flags)

Retrieves a QDR for this EdgeComponentInfo. The QDR identifies the dimension members for the header cell for which this ColumnComponentInfo provides information.

For example, say you have the following column header in a crosstab.

Boston		Paris
January 2000	February 2000	January 2000	February 2000

In an EdgeComponentInfo for the "Boston" cell, the QDR limits Geography to Boston. In an EdgeComponentInfo for the "January 2000" cell under "Paris," the QDR limits Geography to Paris, and it limits Time to January 2000.

Overrides:

getQDR in class ComponentInfo

Parameters:

dataAccess - The DataAccess that provided the data for the header cell that this EdgeComponentInfo describes.

flags - A constant that identifies whether to include page edge information if the QDR is not for the page edge. Valid constants are listed in the See Also section.

Returns:

A QDR that identifies the header cell that this EdgeComponentInfo describes.

See Also:

DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

toString

public java.lang.String toString()

Produces a String that identifies the edge, depth, and index of the component.

Overrides:

toString in class java.lang.Object

Returns:

The edge number, the depth, and the index, in a String. Zero is the column edge, 1 is the row edge, and 2 is the page edge.