oracle.dss.selection
Class OlapQDRMember

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

All Implemented Interfaces:

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

public class OlapQDRMember

extends QDRMember

A member in an OlapQDR. An OlapQDRMember specifies the members of a dimension to consider.

The OlapQDRMember potentially adds hierarchy and level information along with the actual member value.

See Also:

Serialized Form

Field Summary

static java.lang.String	XML_LIST_NAME_OLAP The XML tag name for a QDRMember that has the LIST type.
static java.lang.String	XML_NAME_OLAP The XML tag name for a QDRMember that has any type except LIST.

Fields inherited from class oracle.dss.util.QDRMember

CURRENT, FIXED, LIST, VARIES

Constructor Summary

OlapQDRMember()
Default constructor.

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

OlapQDRMember(int type, java.lang.Object member, java.lang.Object hierarchy, java.lang.Object level)
Constructor that specifies the type and the member or members that this OlapQDRMember represents.

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

OlapQDRMember(java.lang.String member, java.lang.String hierarchy, java.lang.String level)
Constructor that creates an OlapQDRMember of type FIXED and the member or members that this OlapQDRMember represents.

Method Summary

java.lang.Object	clone() Creates a copy of this OlapQDRMember object.
boolean	contains(OlapQDRMember qdrMember, comparator) Indicates whether this OlapQDRMember contains the specified OlapQDRMember.
boolean	equals(java.lang.Object obj, comparator) Specifies whether this OlapQDRMember is equivalent to the specified Object.
boolean	equals(OlapQDRMember qdrMember, comparator) Specifies whether this OlapQDRMember is equivalent to the specified OlapQDRMember.
java.lang.Object	getHierarchy() Retrieves the member's hierarchy or members' hierarchies that this OlapQDRMember represents.
java.lang.Object	getLevel() Retrieves the member's level or members' levels that this OlapQDRMember represents.
java.lang.String	getTagName() Retrieves the name used for persisting this QDR in XML.
void	setHierarchy(java.lang.Object newHier) Specifies the dimension member hierarchy or members' hierarchies that this OlapQDRMember object represents, when the member type of this OlapQDRMember object is FIXED or LIST.
void	setLevel(java.lang.Object newLevel) Specifies the dimension member level or members' levels that this OlapQDRMember object represents, when the member type of this OlapQDRMember object is FIXED or LIST.
java.lang.String	toString() Generates the string representation of this OlapQDRMember.

Methods inherited from class oracle.dss.util.QDRMember

contains, equals, equals, getData, getType, setData, setType

Methods inherited from class java.lang.Object

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

Field Detail

XML_NAME_OLAP

public static final java.lang.String XML_NAME_OLAP

The XML tag name for a QDRMember that has any type except LIST.

XML_LIST_NAME_OLAP

public static final java.lang.String XML_LIST_NAME_OLAP

The XML tag name for a QDRMember that has the LIST type.

Constructor Detail

OlapQDRMember

public OlapQDRMember()

Default constructor. This constructor creates an empty OlapQDRMember.

OlapQDRMember

public OlapQDRMember(int type)

Constructor that specifies a member type.

Parameters:

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

See Also:

QDRMember.FIXED, QDRMember.VARIES, QDRMember.CURRENT, QDRMember.LIST

OlapQDRMember

public OlapQDRMember(java.lang.String dimMember)

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

Parameters:

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

See Also:

QDRMember.FIXED

OlapQDRMember

public OlapQDRMember(int type,
                     java.lang.Object member,
                     java.lang.Object hierarchy,
                     java.lang.Object level)

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

Parameters:

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

member - The dimension member or members that this OlapQDRMember represents. If type is FIXED, then member 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.

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

level - The dimension member's level or members' levels that this OlapQDRMember represents. If type is FIXED, then level should be a String that identifies the dimension member's level If type is LIST, then level should be a Vector of strings that identify the dimension members' levels.

See Also:

QDRMember.FIXED, QDRMember.VARIES, QDRMember.CURRENT, QDRMember.LIST

OlapQDRMember

public OlapQDRMember(java.lang.String member,
                     java.lang.String hierarchy,
                     java.lang.String level)

Constructor that creates an OlapQDRMember of type FIXED and the member or members that this OlapQDRMember represents.

Parameters:

member - The dimension member or members that this OlapQDRMember represents.

hierarchy - The dimension member's hierarchy or members' hierarchies that this OlapQDRMember represents.

level - The dimension member's level or members' levels that this OlapQDRMember represents.

See Also:

QDRMember.FIXED

Method Detail

clone

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

Creates a copy of this OlapQDRMember object.

Overrides:

clone in class QDRMember

Returns:

A copy of this OlapQDRMember object.

Throws:

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

equals

public boolean equals(OlapQDRMember qdrMember,
                       comparator)

Specifies whether this OlapQDRMember is equivalent to the specified OlapQDRMember. OlapQDRMember objects are equal if: they have the same member type and if they represent exactly the same dimension members, hierarchy, and level or they have the same member type and the same member value, with different hierarchies but equivalent levels

Parameters:

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

comparator - An Object implementing the Comparison interface to allow two levels with different values to be compared for equivalence if their hierarchies are not equal

Returns:

true if the two OlapQDRMember objects have the same type and represent the same item as described above, false if the type is different or if the two OlapQDRMember objects represent different dimension members, hierarchies, levels.

See Also:

QDRMember.getType(), QDRMember.getData()

contains

public boolean contains(OlapQDRMember qdrMember,
                         comparator)

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

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

Parameters:

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

Returns:

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

See Also:

equals(oracle.dss.selection.OlapQDRMember, oracle.dss.metadataUtil.Comparison)

equals

public boolean equals(java.lang.Object obj,
                       comparator)

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

Parameters:

OlapQDRMember - The OlapQDRMember to which you want to compare this OlapQDRMember.

comparator - An Object implementing the Comparison interface to allow two levels with different values to be compared for equivalence if their hierarchies are not equal

Returns:

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

See Also:

QDRMember.getType(), QDRMember.getData()

toString

public java.lang.String toString()

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

Overrides:

toString in class QDRMember

Returns:

The string representation of this OlapQDRMember.

See Also:

QDRMember.getType()

setHierarchy

public void setHierarchy(java.lang.Object newHier)

Specifies the dimension member hierarchy or members' hierarchies that this OlapQDRMember object represents, when the member type of this OlapQDRMember object is FIXED or LIST.

Parameters:

newHier - The object that specifies the member's hierarchy or members' hierarchies that this OlapQDRMember should represent. If the member type is FIXED, then pass a String that identifies the single hierarchy that this OlapQDRMember should represent. If the member type is LIST, then pass a Vector of hierarchies.

See Also:

QDRMember.FIXED, QDRMember.LIST, QDRMember.getType()

getHierarchy

public java.lang.Object getHierarchy()

Retrieves the member's hierarchy or members' hierarchies that this OlapQDRMember represents.

Returns:

The data object that identifies the member's hierarchy or members' hierarchies that this OlapQDRMember represents.

setLevel

public void setLevel(java.lang.Object newLevel)

Specifies the dimension member level or members' levels that this OlapQDRMember object represents, when the member type of this OlapQDRMember object is FIXED or LIST.

Parameters:

newHier - The object that specifies the member's level or members' levels that this OlapQDRMember should represent. If the member type is FIXED, then pass a String that identifies the single level that this OlapQDRMember should represent. If the member type is LIST, then pass a Vector of levels.

See Also:

QDRMember.FIXED, QDRMember.LIST, QDRMember.getType()

getLevel

public java.lang.Object getLevel()

Retrieves the member's level or members' levels that this OlapQDRMember represents.

Returns:

The data object that identifies the member's level or members' levels that this OlapQDRMember represents.

getTagName

public java.lang.String getTagName()

Retrieves the name used for persisting this QDR in XML. If this member is a list, then this method returns a special list name, rather than a plain name.

Overrides:

getTagName in class QDRMember

Returns:

The XML name of this QDR.