QDRMember (Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HierarchicalQDRMember
```
public class QDRMember
extends java.lang.Object
implements VectorClone, oracle.dss.util.persistence.XMLizable, java.io.Serializable
```
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

Fields
Modifier and Type	Field and Description
`static int`	`AGG` Member type: an aggregate member
`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.
`protected java.lang.Object`	`m_data`
`protected int`	`m_intType`
`static int`	`TOTAL` Member type: a total member.
`static int`	`VARIES` Member type: The dimension member varies.
`protected static java.lang.String`	`XML_AGG`
`protected static java.lang.String`	`XML_CURRENT`
`static java.lang.String`	`XML_LIST_NAME`
`static java.lang.String`	`XML_NAME`
`static java.lang.String`	`XML_NAME_NEW`
`protected static java.lang.String`	`XML_TOTAL`
`protected static java.lang.String`	`XML_VARIES`

Constructor Summary

Constructors
Constructor and Description
`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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates a copy of this `QDRMember` object.
`boolean`	`contains(QDRMember qdrMember)` Indicates whether this `QDRMember` contains the specified `QDRMember`.
`protected boolean`	`contains(java.util.Vector vector1, java.util.Vector vector2)`
`protected java.lang.String`	`convertTypeIntToString(int type)`
`protected int`	`convertTypeStringToInt(java.lang.String strType)`
`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.util.Vector`	`getAllDependentIDs(java.lang.String measDim, NameConverter nc)`
`java.lang.Object`	`getData()` Retrieves the dimension member or members that this `QDRMember` represents.
`java.lang.String`	`getStateString(MemberContext memberContext)`
`java.lang.String`	`getTagName()` Retrieves the name that is used to represent this object in XML.
`int`	`getType()` Retrieves the type of this `QDRMember` object.
`java.lang.Object`	`getXML(oracle.dss.util.persistence.XMLContext context)` Returns the XML representation of the object.
`int`	`hashCode()`
`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.
`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 `QDRMember`.

Methods inherited from class java.lang.Object
finalize, getClass, 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".
    
    See Also:
    
    Constant Field Values
  - 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.
    
    See Also:
    
    Constant Field Values
  - CURRENT
```
public static final int CURRENT
```
    Member type: The current Time period.
    
    See Also:
    
    Constant Field Values
  - LIST
```
public static final int LIST
```
    Member type: A list of dimension members.
    
    See Also:
    
    Constant Field Values
  - TOTAL
```
public static final int TOTAL
```
    Member type: a total member.
    
    See Also:
    
    Constant Field Values
  - AGG
```
public static final int AGG
```
    Member type: an aggregate member
    
    See Also:
    
    Constant Field Values
  - XML_VARIES
```
protected static final java.lang.String XML_VARIES
```
    See Also:
    
    Constant Field Values
  - XML_CURRENT
```
protected static final java.lang.String XML_CURRENT
```
    See Also:
    
    Constant Field Values
  - XML_TOTAL
```
protected static final java.lang.String XML_TOTAL
```
    See Also:
    
    Constant Field Values
  - XML_AGG
```
protected static final java.lang.String XML_AGG
```
    See Also:
    
    Constant Field Values
  - m_intType
```
protected int m_intType
```
  - m_data
```
protected java.lang.Object m_data
```
  - XML_NAME
```
@Concealed
public static final java.lang.String XML_NAME
```
    See Also:
    
    Constant Field Values
    
    For internal use only. Application developers should not use this
    
    The XML tag name for a QDRMember that has any type except LIST.
  - XML_NAME_NEW
```
@Concealed
public static final java.lang.String XML_NAME_NEW
```
    See Also:
    
    Constant Field Values
  - XML_LIST_NAME
```
@Concealed
public static final java.lang.String XML_LIST_NAME
```
    See Also:
    
    Constant Field Values
    
    For internal use only. Application developers should not use this
    
    The XML tag name for a QDRMember that has the LIST type.
- 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
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    For internal use only. Application developers should not use this
    
    Compute a hashcode for the QDRMember
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Creates a copy of this QDRMember object.
    
    Specified by:
    
    clone in interface VectorClone
    
    Overrides:
    
    clone in class java.lang.Object
    
    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
```
protected boolean contains(java.util.Vector vector1,
                           java.util.Vector vector2)
```
    For internal use only. Application developers should not use this
  - 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.
  - getAllDependentIDs
```
public java.util.Vector getAllDependentIDs(java.lang.String measDim,
                                           NameConverter nc)
```
    For internal use only. Application developers should not use this
  - 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
    
    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
    
    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.
  - getTagName
```
public java.lang.String getTagName()
```
    Description copied from interface: oracle.dss.util.persistence.XMLizable
    
    Retrieves the name that is used to represent this object in XML. This is useful for other objects to find out the name or the type of the sub-objects without parsing the XML
    
    Specified by:
    
    getTagName in interface oracle.dss.util.persistence.XMLizable
    
    Returns:
    
    The XML name of this QDR.
    
    For internal use only. Application developers should not use this
    
    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.
  - convertTypeIntToString
```
protected java.lang.String convertTypeIntToString(int type)
```
    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)
```
    For internal use only. Application developers should not use this
    
    Converts type String constants to Integer constants. This is used by setXML() method.
  - getStateString
```
public java.lang.String getStateString(MemberContext memberContext)
```

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

Class QDRMember

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIXED

VARIES

CURRENT

LIST

TOTAL

AGG

XML_VARIES

XML_CURRENT

XML_TOTAL

XML_AGG

m_intType

m_data

XML_NAME

XML_NAME_NEW

XML_LIST_NAME

Constructor Detail

QDRMember

QDRMember

QDRMember

QDRMember

Method Detail

hashCode

clone

equals

contains

contains

equals

toString

setType

getType

setData

getData

getAllDependentIDs

getXML

setXML

getTagName

convertTypeIntToString

convertTypeStringToInt

getStateString