IEssAttributeQuery (Oracle Essbase Java API Reference)

All Superinterfaces:

IEssBaseObject

All Known Subinterfaces:

IEssVaryingAttributeQuery
```
public interface IEssAttributeQuery
extends IEssBaseObject
```
This is to define a query for performing complex Attribute Query Operations.
This allows you to define the following:
- Input Member* (as a member object or as member name)
- Input Member Type*
- Output Member Type*
- [Attribute Value, Operation Type]
- [Member index, max count of members]
Author:

Balaji Sundaresan

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`MBR_TYPE_ATTRIBUTE_DIMENSION`
`static short`	`MBR_TYPE_ATTRIBUTE_MEMBER`
`static short`	`MBR_TYPE_ATTRIBUTED_MEMBER`
`static short`	`MBR_TYPE_BASE_DIMENSION`
`static short`	`MBR_TYPE_BASE_MEMBER`
`static short`	`MBR_TYPE_INVALID_MEMBER` Attribute related member (query input/output ) type
`static short`	`MBR_TYPE_STANDARD_DIMENSION`
`static short`	`MBR_TYPE_STANDARD_MEMBER`
`static short`	`OP_ALL` "Any" attribute querying operator.
`static short`	`OP_EQ` Equal-to attribute querying operator
`static short`	`OP_GT` Greater-Than attribute querying operator
`static short`	`OP_GTE` Greater-Than-or-Equal-to attribute querying operator
`static short`	`OP_LT` Less-Than attribute querying operator
`static short`	`OP_LTE` Less-Than-or-Equal-to attribute querying operator
`static short`	`OP_NEQ` Not-equal-to attribute querying operator
`static short`	`OP_TYPEOF` Type-of attribute querying operator

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAttributeValue()` If the attribute value type is String, then a `String` value object is returned.
`java.lang.Object`	`getInputMember()` Returns the input member depending on one of the possible types, such as either `IEssMember` type or `String`.
`short`	`getInputMemberType()` Returns the type of input member defined for attribute querying.
`int`	`getMaxMemberCount()` Returns the maximum count of members this query can return.
`short`	`getOperationType()` Returns the operator type used.
`short`	`getOutputMemberType()` Returns the type of expected member.
`int`	`getStartMemberIndex()` Gets the Start Member Index.
`void`	`set(short inputMbrType, short outputMbrType)` Specify the type of input member you are specifying in the query and what type of member you are expecting in the results.
`void`	`setAttributeValue(short opernType, boolean booleanTypeAttrValue)` Use this to query Boolean type of attributes by specifying the attribute value in `boolean` value and using the Attribute Querying operator of your choice.
`void`	`setAttributeValue(short opernType, double doubleTypeAttrValue)` Use this to query Floating Point type of attributes by specifying the attribute value as a `double`value and using the Attribute Querying operator of your choice.
`void`	`setAttributeValue(short opernType, long dateTimeTypeAttrValue)` Use this to query Date type of attributes by specifying the attribute value as a timestamp value and using the Attribute Querying operator of your choice.
`void`	`setAttributeValue(short opernType, java.lang.String stringTypeAttrValue)` Use this to query Text based attributes by specifying the attribute value in `String` and using the Attribute Querying operator of your choice.
`void`	`setInputMember(IEssMember member)` This is to specify the input member/dimension name to query on.
`void`	`setInputMember(java.lang.String memberName)` This is to specify the input member/dimension name to query on.
`void`	`setMemberRange(int startMemberIndex, int maxMemberCount)` This is to limit the result of members that will be returned based on your specified counts, to achieve capabilities equivalent to cursoring.

- Field Detail
  - MBR_TYPE_INVALID_MEMBER
```
static final short MBR_TYPE_INVALID_MEMBER
```
    Attribute related member (query input/output ) type
    
    See Also:
    
    Constant Field Values
  - MBR_TYPE_STANDARD_MEMBER
```
static final short MBR_TYPE_STANDARD_MEMBER
```
    See Also:
    
    Constant Field Values
  - MBR_TYPE_STANDARD_DIMENSION
```
static final short MBR_TYPE_STANDARD_DIMENSION
```
    See Also:
    
    Constant Field Values
  - MBR_TYPE_BASE_MEMBER
```
static final short MBR_TYPE_BASE_MEMBER
```
    See Also:
    
    Constant Field Values
  - MBR_TYPE_BASE_DIMENSION
```
static final short MBR_TYPE_BASE_DIMENSION
```
    See Also:
    
    Constant Field Values
  - MBR_TYPE_ATTRIBUTE_MEMBER
```
static final short MBR_TYPE_ATTRIBUTE_MEMBER
```
    See Also:
    
    Constant Field Values
  - MBR_TYPE_ATTRIBUTE_DIMENSION
```
static final short MBR_TYPE_ATTRIBUTE_DIMENSION
```
    See Also:
    
    Constant Field Values
  - MBR_TYPE_ATTRIBUTED_MEMBER
```
static final short MBR_TYPE_ATTRIBUTED_MEMBER
```
    See Also:
    
    Constant Field Values
  - OP_EQ
```
static final short OP_EQ
```
    Equal-to attribute querying operator
    
    See Also:
    
    Constant Field Values
  - OP_NEQ
```
static final short OP_NEQ
```
    Not-equal-to attribute querying operator
    
    See Also:
    
    Constant Field Values
  - OP_GT
```
static final short OP_GT
```
    Greater-Than attribute querying operator
    
    See Also:
    
    Constant Field Values
  - OP_LT
```
static final short OP_LT
```
    Less-Than attribute querying operator
    
    See Also:
    
    Constant Field Values
  - OP_GTE
```
static final short OP_GTE
```
    Greater-Than-or-Equal-to attribute querying operator
    
    See Also:
    
    Constant Field Values
  - OP_LTE
```
static final short OP_LTE
```
    Less-Than-or-Equal-to attribute querying operator
    
    See Also:
    
    Constant Field Values
  - OP_TYPEOF
```
static final short OP_TYPEOF
```
    Type-of attribute querying operator
    
    See Also:
    
    Constant Field Values
  - OP_ALL
```
static final short OP_ALL
```
    "Any" attribute querying operator.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - set
```
void set(short inputMbrType,
         short outputMbrType)
```
    Specify the type of input member you are specifying in the query and what type of member you are expecting in the results. It is mandatory to specify this in attribute querying as it wont make sense without this specification.
    Both inputMbrType and outputMbrType has be IEssAttributeQuery.MBR_TYPE_*.
    The input member type corresponds to the member you will set using setInputMember(String) or setInputMember(IEssMember).
    
    Parameters:
    
    inputMbrType - Input member type (one of the IEssAttributeQuery.MBR_TYPE_*)
    
    outputMbrType - Expected member type (one of the IEssAttributeQuery.MBR_TYPE_*)
    
    See Also:
    
    setInputMember(String), setInputMember(IEssMember)
  - setInputMember
```
void setInputMember(java.lang.String memberName)
```
    This is to specify the input member/dimension name to query on.
    It is mandatory to specify input member for attribute querying as it wont make sense without this specification. So, you need to do that either using this method or setInputMember(IEssMember).
    Please note you need to specify the type of input member using set(short, short).
    
    Parameters:
    
    memberName - Member or Dimension Name.
    
    See Also:
    
    set(short, short)
  - setInputMember
```
void setInputMember(IEssMember member)
```
    This is to specify the input member/dimension name to query on.
    It is mandatory to specify input member for attribute querying as it wont make sense without this specification. So, you need to do that either using this method or setInputMember(String).
    Please note you also need to specify the type of input member using set(short, short).
    
    Parameters:
    
    member - Member or Dimension Name.
    
    See Also:
    
    set(short, short)
  - setAttributeValue
```
void setAttributeValue(short opernType,
                       java.lang.String stringTypeAttrValue)
```
    Use this to query Text based attributes by specifying the attribute value in String and using the Attribute Querying operator of your choice.
    For example, myIEssAttributeQuery.setAttributeValue(IEssAttributeQuery.OP_NEQ, "Can");
    
    Parameters:
    
    opernType - Operator Type as in "IEssAttributeQuery.OP_*"
    
    stringTypeAttrValue - attribute value
  - setAttributeValue
```
void setAttributeValue(short opernType,
                       boolean booleanTypeAttrValue)
```
    Use this to query Boolean type of attributes by specifying the attribute value in boolean value and using the Attribute Querying operator of your choice.
    For example, myIEssAttributeQuery.setAttributeValue(IEssAttributeQuery.OP_EQ, true);
    
    Parameters:
    
    opernType - Operator Type as in "IEssAttributeQuery.OP_*"
    
    booleanTypeAttrValue - attribute value.
  - setAttributeValue
```
void setAttributeValue(short opernType,
                       long dateTimeTypeAttrValue)
```
    Use this to query Date type of attributes by specifying the attribute value as a timestamp value and using the Attribute Querying operator of your choice.
    For example, myIEssAttributeQuery.setAttributeValue(IEssAttributeQuery.OP_EQ, 101010102);
    
    Parameters:
    
    opernType - Operator Type as in "IEssAttributeQuery.OP_*"
    
    dateTimeTypeAttrValue - attribute value.
  - setAttributeValue
```
void setAttributeValue(short opernType,
                       double doubleTypeAttrValue)
```
    Use this to query Floating Point type of attributes by specifying the attribute value as a doublevalue and using the Attribute Querying operator of your choice.
    For example, myIEssAttributeQuery.setAttributeValue(IEssAttributeQuery.OP_EQ, 100.20);
    
    Parameters:
    
    opernType - Operator Type as in "IEssAttributeQuery.OP_*"
    
    doubleTypeAttrValue - attribute value.
  - setMemberRange
```
void setMemberRange(int startMemberIndex,
                    int maxMemberCount)
```
    This is to limit the result of members that will be returned based on your specified counts, to achieve capabilities equivalent to cursoring.
    
    Parameters:
    
    startMemberIndex - Starting Member Index
    
    maxMemberCount - Maximum number of members expected from the Query.
  - getInputMemberType
```
short getInputMemberType()
```
    Returns the type of input member defined for attribute querying.
    
    Returns:
    
    input member type.
  - getOutputMemberType
```
short getOutputMemberType()
```
    Returns the type of expected member.
    
    Returns:
    
    output member type.
  - getInputMember
```
java.lang.Object getInputMember()
```
    Returns the input member depending on one of the possible types, such as either IEssMember type or String. If there is no input member defined in this query, returns null.
    
    Returns:
    
    The input member either as member name or as member object.
  - getAttributeValue
```
java.lang.Object getAttributeValue()
```
    If the attribute value type is String, then a String value object is returned. If the attribute value type is boolean, then a Boolean value object is returned. If the attribute value type is DateTime, then a Long value object is returned. If the attribute value type is double, then a Double value object is returned. If there is no attribute value defined in this query, returns null.
    
    Returns:
    
    Attribute Value (if any).
  - getOperationType
```
short getOperationType()
```
    Returns the operator type used.
    
    Returns:
    
    the operator type.
  - getStartMemberIndex
```
int getStartMemberIndex()
```
    Gets the Start Member Index. By default, its set to zero.
    
    Returns:
    
    start member index.
  - getMaxMemberCount
```
int getMaxMemberCount()
```
    Returns the maximum count of members this query can return. By default, its set to return 10000000.
    
    Returns:
    
    max count of members to be returned.

Interface IEssAttributeQuery

Field Summary

Method Summary

Field Detail

MBR_TYPE_INVALID_MEMBER

MBR_TYPE_STANDARD_MEMBER

MBR_TYPE_STANDARD_DIMENSION

MBR_TYPE_BASE_MEMBER

MBR_TYPE_BASE_DIMENSION

MBR_TYPE_ATTRIBUTE_MEMBER

MBR_TYPE_ATTRIBUTE_DIMENSION

MBR_TYPE_ATTRIBUTED_MEMBER

OP_EQ

OP_NEQ

OP_GT

OP_LT

OP_GTE

OP_LTE

OP_TYPEOF

OP_ALL

Method Detail

set

setInputMember

setInputMember

setAttributeValue

setAttributeValue

setAttributeValue

setAttributeValue

setMemberRange

getInputMemberType

getOutputMemberType

getInputMember

getAttributeValue

getOperationType

getStartMemberIndex

getMaxMemberCount