oracle.dss.util
Class SeriesComponentInfo

java.lang.Object
  oracle.dss.util.ComponentInfo
      oracle.dss.util.SeriesComponentInfo

All Implemented Interfaces:

java.lang.Cloneable

public class SeriesComponentInfo
extends ComponentInfo

Series information about a component in a Graph. Used for components that have data associated with them.

Constructor Summary

SeriesComponentInfo(int series)
Constructor.

SeriesComponentInfo(int series, int edge)
Constructor that specifies the series and the edge.

Method Summary

java.lang.Object	clone() Clones this SeriesComponentInfo.
boolean	equals(java.lang.Object o) Indicates whether the specified object is equivalent to this SeriesComponentInfo.
int	getEdge() Retrieves the edge that the series is on.
QDR	getQDR(DataAccess dataAccess, int flags) Retrieves a QDR for this SeriesComponentInfo.
int	getSeries() Retrieves the series number.
int	hashCode()
java.lang.String	toString() Produces a String that identifies the series.

Methods inherited from class java.lang.Object

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

Constructor Detail

SeriesComponentInfo

public SeriesComponentInfo(int series)

Constructor.

Parameters:

series - The series that the component is in.

SeriesComponentInfo

public SeriesComponentInfo(int series,
                           int edge)

Constructor that specifies the series and the edge.

Parameters:

series - the series the component is in.

edge - The edge that series is on. Possible values are listed in the See Also section. The value depends on the return value of the Graph.isDataRowShownAsASeries.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, oracle.dss.graph

Method Detail

clone

public java.lang.Object clone()

Clones this SeriesComponentInfo.

Specified by:

clone in class ComponentInfo

Returns:

The clone of this SeriesComponentInfo.

getSeries

public int getSeries()

Retrieves the series number. Series numbers start at zero.

Returns:

The series number.

getEdge

public int getEdge()

Retrieves the edge that the series is on.

Returns:

The edge the series is on. Possible values are listed in the See Also section. The value depends on the return value of the Graph.isDataRowShownAsASeries.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, Graph.isDataRowShownAsASeries()

equals

public boolean equals(java.lang.Object o)

Indicates whether the specified object is equivalent to this SeriesComponentInfo. SeriesComponentInfo objects are equivalent if they refer to the same series.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare with this SeriesComponentInfo.

Returns:

true if both objects refer to the same series, false if not or if o is not a SeriesComponentInfo.

getQDR

public QDR getQDR(DataAccess dataAccess,
                  int flags)

Retrieves a QDR for this SeriesComponentInfo. The QDR identifies the dimension members for the data series for which this SeriesComponentInfo provides information.

Specified by:

getQDR in class ComponentInfo

Parameters:

dataAccess - The DataAccess that provided the data for the series that this SeriesComponentInfo 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 row of data that this SeriesComponentInfo describes.

See Also:

DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

hashCode

public int hashCode()

Specified by:

hashCode in class ComponentInfo

toString

public java.lang.String toString()

Produces a String that identifies the series.

Overrides:

toString in class java.lang.Object

Returns:

The series number, in a String.