oracle.dss.util

Class HierarchicalQDRMember

java.lang.Object

oracle.dss.util.QDRMember

oracle.dss.util.HierarchicalQDRMember

All Implemented Interfaces:

java.io.Serializable, oracle.dss.util.persistence.XMLizable, VectorClone

public class HierarchicalQDRMember
extends QDRMember

Since:

release specific (what release of product did this appear in) A HierarchicalQDRMember specifies the members of a dimension to consider in a HierarchicalQDR.

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

See Also:

QDR, QDRMember, HierarchicalQDR, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	m_hier
protected java.lang.Object	m_level
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

AGG, CURRENT, FIXED, LIST, m_data, m_intType, TOTAL, VARIES, XML_AGG, XML_LIST_NAME, XML_NAME, XML_NAME_NEW, XML_TOTAL

Constructor Summary

Constructors

Constructor and Description
HierarchicalQDRMember() Default constructor.
HierarchicalQDRMember(int type) Constructor that specifies a member type.
HierarchicalQDRMember(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 HierarchicalQDRMember represents.
HierarchicalQDRMember(java.lang.String dimMember) Constructor that specifies the name of dimension member.
HierarchicalQDRMember(java.lang.String member, java.lang.String hierarchy, java.lang.String level) Constructor that creates a HierarchicalQDRMember of type FIXED and the member or members that this HierarchicalQDRMember represents.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of this HierarchicalQDRMember object.
protected boolean	comparePieces(java.lang.Object data, java.lang.Object cmpData, Comparison comparator)
boolean	contains(HierarchicalQDRMember qdrMember) Indicates whether this HierarchicalQDRMember contains the specified HierarchicalQDRMember.
boolean	contains(HierarchicalQDRMember qdrMember, Comparison comparator) Indicates whether this HierarchicalQDRMember contains the specified HierarchicalQDRMember.
protected boolean	contains(java.util.Vector v1, java.util.Vector v2, Comparison comparator)
protected java.lang.String	convertTypeIntToString(int type)
protected int	convertTypeStringToInt(java.lang.String strType)
boolean	equals(HierarchicalQDRMember qdrMember) Specifies whether this HierarchicalQDRMember is equivalent to the specified HierarchicalQDRMember.
boolean	equals(HierarchicalQDRMember qdrMember, Comparison comparator) Specifies whether this HierarchicalQDRMember is equivalent to the specified HierarchicalQDRMember.
boolean	equals(java.lang.Object obj) Specifies whether this HierarchicalQDRMember is equivalent to the specified Object.
boolean	equals(java.lang.Object obj, Comparison comparator) Specifies whether this HierarchicalQDRMember is equivalent to the specified Object.
java.util.Vector	getAllDependentIDs(java.lang.String measDim, NameConverter nc)
protected java.lang.String	getDataString()
java.lang.Object	getHierarchy() Retrieves the member's hierarchy or members' hierarchies that this HierarchicalQDRMember represents.
protected java.lang.String	getHierarchyTag()
protected java.lang.String	getHierString()
java.lang.Object	getLevel() Retrieves the member's level or members' levels that this HierarchicalQDRMember represents.
protected java.lang.String	getLevelString()
protected java.lang.String	getLevelTag()
protected java.lang.String	getMemberTag()
protected java.lang.String	getMemberTypeTag()
java.lang.String	getTagName() Retrieves the name used for persisting this QDR in XML.
java.lang.Object	getXML(oracle.dss.util.persistence.XMLContext context) Returns the XML representation of the object.
int	hashCode()
void	setHierarchy(java.lang.Object newHier) Specifies the dimension member hierarchy or members' hierarchies that this HierarchicalQDRMember object represents, when the member type of this HierarchicalQDRMember object is FIXED or LIST.
void	setLevel(java.lang.Object newLevel) Specifies the dimension member level or members' levels that this HierarchicalQDRMember object represents, when the member type of this HierarchicalQDRMember object is FIXED or LIST.
void	setXML(oracle.dss.util.persistence.XMLContext context, java.lang.Object node) Sets the XML representation of the object.
java.lang.String	toString() Generates the string representation of this HierarchicalQDRMember.

Methods inherited from class oracle.dss.util.QDRMember

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

Methods inherited from class java.lang.Object

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

Field Detail

XML_NAME_OLAP

@Concealed
public static final java.lang.String XML_NAME_OLAP

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

See Also:

Constant Field Values

XML_LIST_NAME_OLAP

@Concealed
public static final java.lang.String XML_LIST_NAME_OLAP

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

See Also:

Constant Field Values

m_hier

protected java.lang.Object m_hier

For internal use only. Application developers should not use this

m_level

protected java.lang.Object m_level

For internal use only. Application developers should not use this

Constructor Detail

HierarchicalQDRMember

public HierarchicalQDRMember()

Default constructor. This constructor creates an empty HierarchicalQDRMember.

HierarchicalQDRMember

public HierarchicalQDRMember(int type)

Constructor that specifies a member type.

Parameters:

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

See Also:

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

HierarchicalQDRMember

public HierarchicalQDRMember(java.lang.String dimMember)

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

Parameters:

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

See Also:

QDRMember.FIXED

HierarchicalQDRMember

public HierarchicalQDRMember(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 HierarchicalQDRMember represents.

Parameters:

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

member - The dimension member or members that this HierarchicalQDRMember 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 HierarchicalQDRMember 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 HierarchicalQDRMember 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

HierarchicalQDRMember

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

Constructor that creates a HierarchicalQDRMember of type FIXED and the member or members that this HierarchicalQDRMember represents.

Parameters:

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

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

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

See Also:

QDRMember.FIXED

Method Detail

setHierarchy

public void setHierarchy(java.lang.Object newHier)

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

Parameters:

newHier - The object that specifies the member's hierarchy or members' hierarchies that this HierarchicalQDRMember should represent. If the member type is FIXED, then pass a String that identifies the single hierarchy that this HierarchicalQDRMember 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 HierarchicalQDRMember represents.

Returns:

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

setLevel

public void setLevel(java.lang.Object newLevel)

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

Parameters:

newHier - The object that specifies the member's level or members' levels that this HierarchicalQDRMember should represent. If the member type is FIXED, then pass a String that identifies the single level that this HierarchicalQDRMember 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 HierarchicalQDRMember represents.

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class QDRMember

For internal use only. Application developers should not use this

Compute a hashcode for the HierarchicalQDRMember

clone

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

Creates a copy of this HierarchicalQDRMember object.

Specified by:

clone in interface VectorClone

Overrides:

clone in class QDRMember

Returns:

A copy of this HierarchicalQDRMember object.

Throws:

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

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.

Specified by:

getTagName in interface oracle.dss.util.persistence.XMLizable

Overrides:

getTagName in class QDRMember

Returns:

The XML name of this QDR.

getMemberTag

protected java.lang.String getMemberTag()

getLevelTag

protected java.lang.String getLevelTag()

getHierarchyTag

protected java.lang.String getHierarchyTag()

getMemberTypeTag

protected java.lang.String getMemberTypeTag()

getXML

public java.lang.Object getXML(oracle.dss.util.persistence.XMLContext context)

Description copied from interface: oracle.dss.util.persistence.XMLizable

Returns the XML representation of the object. Note that XML representation can be of any type. The XML returned could contain only partial updates of the states. However, it is up to the implementor to decide whether this should be supported. (i.e. Not mandatory)

Specified by:

getXML in interface oracle.dss.util.persistence.XMLizable

Overrides:

getXML in class QDRMember

Parameters:

context - The control settings that is send by the container (caller)

Returns:

The root ObjectNode of the persistence object tree.

See Also:

ObjectScope

For internal use only. Application developers should not use this

Retrieves the QDRMember representation in XML in context of the Persistence framework.

setXML

public void setXML(oracle.dss.util.persistence.XMLContext context,
                   java.lang.Object node)

Description copied from interface: oracle.dss.util.persistence.XMLizable

Sets the XML representation of the object. Note that XML representation can be of any type

Specified by:

setXML in interface oracle.dss.util.persistence.XMLizable

Overrides:

setXML in class QDRMember

Parameters:

node - The root ObjectNode of the persistence object tree.

For internal use only. Application developers should not use this

Specifies the QDRMember data from the specified persistence object tree.

convertTypeIntToString

protected java.lang.String convertTypeIntToString(int type)

Overrides:

convertTypeIntToString in class QDRMember

For internal use only. Application developers should not use this

Converts type Integer constants to String constants. This is used by getXML() method.

convertTypeStringToInt

protected int convertTypeStringToInt(java.lang.String strType)

Overrides:

convertTypeStringToInt in class QDRMember

For internal use only. Application developers should not use this

Converts type String constants to Integer constants. This is used by setXML() method.

getAllDependentIDs

public java.util.Vector getAllDependentIDs(java.lang.String measDim,
                                           NameConverter nc)

Overrides:

getAllDependentIDs in class QDRMember

For internal use only. Application developers should not use this

toString

public java.lang.String toString()

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

Overrides:

toString in class QDRMember

Returns:

The string representation of this HierarchicalQDRMember.

See Also:

QDRMember.getType()

getHierString

protected java.lang.String getHierString()

For internal use only. Application developers should not use this

getLevelString

protected java.lang.String getLevelString()

For internal use only. Application developers should not use this

getDataString

protected java.lang.String getDataString()

For internal use only. Application developers should not use this

Allow subclass to override

comparePieces

protected boolean comparePieces(java.lang.Object data,
                                java.lang.Object cmpData,
                                Comparison comparator)

For internal use only. Application developers should not use this

contains

protected boolean contains(java.util.Vector v1,
                           java.util.Vector v2,
                           Comparison comparator)

For internal use only. Application developers should not use this

contains

public boolean contains(HierarchicalQDRMember qdrMember,
                        Comparison comparator)

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

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

Parameters:

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

Returns:

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

See Also:

equals(oracle.dss.util.HierarchicalQDRMember, oracle.dss.util.Comparison)

For internal use only. Application developers should not use this

contains

public boolean contains(HierarchicalQDRMember qdrMember)

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

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

Parameters:

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

Returns:

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

See Also:

equals(oracle.dss.util.HierarchicalQDRMember, oracle.dss.util.Comparison)

equals

public boolean equals(HierarchicalQDRMember qdrMember,
                      Comparison comparator)

Specifies whether this HierarchicalQDRMember is equivalent to the specified HierarchicalQDRMember. HierarchicalQDRMember 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 HierarchicalQDRMember to which you want to compare this HierarchicalQDRMember.

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 HierarchicalQDRMember objects have the same type and represent the same item as described above, false if the type is different or if the two HierarchicalQDRMember objects represent different dimension members, hierarchies, levels.

See Also:

QDRMember.getType(), QDRMember.getData()

For internal use only. Application developers should not use this

equals

public boolean equals(HierarchicalQDRMember qdrMember)

Specifies whether this HierarchicalQDRMember is equivalent to the specified HierarchicalQDRMember. HierarchicalQDRMember objects are equal if they have the same member type and if they represent exactly the same dimension members, hierarchy, and level.

Parameters:

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

Returns:

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

See Also:

QDRMember.getType(), QDRMember.getData()

equals

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

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

Parameters:

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

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 HierarchicalQDRMember objects have the same type and represent the same dimension members, false if the type is different, if the two HierarchicalQDRMember objects represent different dimension members, or if obj is not a HierarchicalQDRMember.

See Also:

QDRMember.getType(), QDRMember.getData()

For internal use only. Application developers should not use this

equals

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class QDRMember

Parameters:

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

Returns:

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

See Also:

QDRMember.getType(), QDRMember.getData()