oracle.dss.util
Class QDRMember

java.lang.Object
  |
  +--oracle.dss.util.QDRMember

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable, VectorClone

Direct Known Subclasses:

OlapQDRMember

public class QDRMember

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable, VectorClone

A member in a QDR. A QDRMember specifies the members of a dimension to consider.

There are four different types of QDRMember objects:

• Fixed members refer to a single dimension member, such as "Shoes" or "Tokyo".
• List members refer to a list of dimension members, such as "Paris", "London", and "Madrid".
• Current members refer only to the current time period.
• Varied members refer to all members of a dimension. A dimension-only QDR uses a QDRMember that has type VARIES. Also, varied members are used in ranking reports.

See Also:

FIXED, LIST, CURRENT, VARIES, QDR, Serialized Form

Field Summary

static int	CURRENT Member type: The current Time period.
static int	FIXED Member type: The dimension member is a single, fixed member, such as "PARIS".
static int	LIST Member type: A list of dimension members.
static int	VARIES Member type: The dimension member varies.

Constructor Summary

QDRMember()
Default constructor.

QDRMember(int type)
Constructor that specifies a member type.

QDRMember(int type, java.lang.Object data)
Constructor that specifies the type and the member or members that this QDRMember represents.

QDRMember(java.lang.String dimMember)
Constructor that specifies the name of dimension member.

Method Summary

java.lang.Object	clone() Creates a copy of this QDRMember object.
boolean	contains(QDRMember qdrMember) Indicates whether this QDRMember contains the specified QDRMember.
boolean	equals(java.lang.Object obj) Specifies whether this QDRMember is equivalent to the specified Object.
boolean	equals(QDRMember qdrMember) Specifies whether this QDRMember is equivalent to the specified QDRMember.
java.lang.Object	getData() Retrieves the dimension member or members that this QDRMember represents.
int	getType() Retrieves the type of this QDRMember object.
void	setData(java.lang.Object newData) Specifies the dimension member or members that this QDRMember object represents, when the member type of this QDRMember object is FIXED or LIST.
void	setType(int type) Specifies the type of this QDRMember object.
java.lang.String	toString() Generates the string representation of this QDRMember.

Methods inherited from class java.lang.Object

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

Field Detail

FIXED

public static final int FIXED

Member type: The dimension member is a single, fixed member, such as "PARIS".

VARIES

public static final int VARIES

Member type: The dimension member varies. Use this type for a dimension-only QDR, or for a ranking report. For example, suppose that you have the following crosstab:

		June	July
Tokyo
	Internet phones	2314	2978
	PDAs	1834	2411
	Pagers	817	699
Chicago
	Pagers	5004	3917
	Cell phones	3956	4057
	PDAs	2887	3422

The Product dimension is set to the top three products based on Sales, in June, by Direct channel, in the current city. Here, the QDRMember for the Geography varies, so that a different selection of products can appear for each Geography member in the crosstab.

CURRENT

public static final int CURRENT

Member type: The current Time period.

LIST

public static final int LIST

Member type: A list of dimension members.

Constructor Detail

QDRMember

public QDRMember()

Default constructor. This constructor creates an empty QDRMember.

QDRMember

public QDRMember(int type)

Constructor that specifies a member type.

Parameters:

type - A constant that represents the type of data that this QDRMember object represents.

See Also:

FIXED, VARIES, CURRENT, LIST

QDRMember

public QDRMember(java.lang.String dimMember)

Constructor that specifies the name of dimension member. The member type is impled to be QDRMember.FIXED.

Parameters:

dimMember - The name of the dimension member that this QDRMember represents.

See Also:

FIXED

QDRMember

public QDRMember(int type,
                 java.lang.Object data)

Constructor that specifies the type and the member or members that this QDRMember represents.

Parameters:

type - A constant that represents the type of data that this QDRMember object represents. The valid constants are listed in the See Also section.

data - The dimension member or members that this QDRMember represents. If type is FIXED, then data should be a String that identifies the dimension member. If type is LIST, then data should be a Vector of strings that identify the dimension members.

See Also:

FIXED, VARIES, CURRENT, LIST

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates a copy of this QDRMember object.

Specified by:

clone in interface VectorClone

Returns:

A copy of this QDRMember object.

Throws:

java.lang.CloneNotSupportedException - If cloning is not supported for any of the fields.

equals

public boolean equals(QDRMember qdrMember)

Specifies whether this QDRMember is equivalent to the specified QDRMember. QDRMember objects are equivalent if they have the same member type and if they represent exactly the same dimension members.

Parameters:

qdrMember - The QDRMember to which you want to compare this QDRMember.

Returns:

true if the two QDRMember objects have the same type and represent the same dimension members, false if the type is different or if the two QDRMember objects represent different dimension members.

See Also:

getType(), getData()

contains

public boolean contains(QDRMember qdrMember)

Indicates whether this QDRMember contains the specified QDRMember. This QDRMember contains the specified QDRMember if it represents all of the dimension members that the specified QDRMember represents.

A QDRMember that has the VARIES type contains any other QDRMember. If two QDRMember objects are equivalent, then they each contain the other.

Parameters:

qdrMember - The QDRMember with which you want to compare this QDRMember.

Returns:

true if this QDRMember represents all of the dimension members that qdrMember represents, false if qdrMember is null or if qdrMember represents any dimension members that this QDRMember does not represent.

See Also:

equals(oracle.dss.util.QDRMember)

equals

public boolean equals(java.lang.Object obj)

Specifies whether this QDRMember is equivalent to the specified Object. QDRMember objects are equivalent if they have the same member type and if they represent exactly the same dimension members.

Overrides:

equals in class java.lang.Object

Parameters:

qdrMember - The QDRMember to which you want to compare this QDRMember.

Returns:

true if the two QDRMember objects have the same type and represent the same dimension members, false if the type is different, if the two QDRMember objects represent different dimension members, or if obj is not a QDRMember.

See Also:

getType(), getData()

toString

public java.lang.String toString()

Generates the string representation of this QDRMember. If the member type of this QDRMember object is FIXED or LIST, then this method generates a String that identifies the members that this QDRMember represents.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of this QDRMember.

See Also:

getType()

setType

public void setType(int type)

Specifies the type of this QDRMember object.

Parameters:

type - A constant that represents the type of data that this QDRMember object represents. Valid constants are listed in the See Also section.

See Also:

FIXED, VARIES, CURRENT, LIST

getType

public int getType()

Retrieves the type of this QDRMember object.

Returns:

The constant that represents the type. The valid constants are listed in the See Also section.

See Also:

FIXED, VARIES, CURRENT, LIST

setData

public void setData(java.lang.Object newData)

Specifies the dimension member or members that this QDRMember object represents, when the member type of this QDRMember object is FIXED or LIST.

Parameters:

newData - The object that specifies the dimension member or members that this QDRMember should represent. If the member type is FIXED, then pass a String that identifies the single dimension member that this QDRMember should represent. If the member type is LIST, then pass a Vector of dimension members.

See Also:

FIXED, LIST, getType()

getData

public java.lang.Object getData()

Retrieves the dimension member or members that this QDRMember represents.

Returns:

The data object that identifies the dimension member or members that this QDRMember represents.