|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssMemberSelection interface.
Nested Class Summary |
Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
Field Summary | |
static int |
QUERY_OPTION_ALIASESONLY
|
static int |
QUERY_OPTION_COUNTONLY
|
static int |
QUERY_OPTION_MEMBERSANDALIASES
|
static int |
QUERY_OPTION_MEMBERSONLY
Query options. |
static int |
QUERY_TYPE_ANCESTORS
|
static int |
QUERY_TYPE_BOTTOMLEVEL
|
static int |
QUERY_TYPE_CHILDREN
Query types. |
static int |
QUERY_TYPE_DESCENDANTS
|
static int |
QUERY_TYPE_DIMENSION
|
static int |
QUERY_TYPE_DIMUSERATTRIBUTES
|
static int |
QUERY_TYPE_DTSMEMBERS
|
static int |
QUERY_TYPE_NAMEDGENERATION
|
static int |
QUERY_TYPE_NAMEDLEVEL
|
static int |
QUERY_TYPE_PARENT
|
static int |
QUERY_TYPE_SAMEGENERATION
|
static int |
QUERY_TYPE_SAMELEVEL
|
static int |
QUERY_TYPE_SEARCH
|
static int |
QUERY_TYPE_SIBLINGS
|
static int |
QUERY_TYPE_USERATTRIBUTE
|
static int |
QUERY_TYPE_WILDSEARCH
|
Method Summary | |
void |
close()
Closes the member selection. |
void |
executeQuery(java.lang.String memberName)
Exexecutes member selection query to fetch specified member. |
void |
executeQuery(java.lang.String mbrName,
int queryType,
int queryOptions,
java.lang.String dimName,
java.lang.String input1,
java.lang.String input2)
Executes the member selection query. |
void |
executeQuery(java.lang.String mbrName,
int queryType,
int queryOptions,
java.lang.String dimName,
java.lang.String input1,
java.lang.String input2,
int startMemberIndex,
int maxMemberCount)
Executes the member selection query. |
void |
executeQuery(java.lang.String fieldSelection,
java.lang.String mbrSelection)
Executes the member selection query. |
int |
getCountMembers()
Gets the count of resulting members. |
IEssCube |
getCube()
Gets the parent cube. |
IEssIterator |
getMembers()
Gets the resulting members. |
java.lang.String |
getName()
Gets the name of the member selection. |
void |
open()
Opens the member selection. |
Methods inherited from interface com.essbase.api.base.IEssExtendedObject |
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled |
Methods inherited from interface com.essbase.api.base.IEssProperties |
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, refreshPropertyValues, setPropertyValueAny, setPropertyValueAny, updatePropertyValues |
Field Detail |
public static final int QUERY_TYPE_CHILDREN
public static final int QUERY_TYPE_DESCENDANTS
public static final int QUERY_TYPE_BOTTOMLEVEL
public static final int QUERY_TYPE_SIBLINGS
public static final int QUERY_TYPE_SAMELEVEL
public static final int QUERY_TYPE_SAMEGENERATION
public static final int QUERY_TYPE_PARENT
public static final int QUERY_TYPE_DIMENSION
public static final int QUERY_TYPE_NAMEDGENERATION
public static final int QUERY_TYPE_NAMEDLEVEL
public static final int QUERY_TYPE_SEARCH
public static final int QUERY_TYPE_WILDSEARCH
public static final int QUERY_TYPE_USERATTRIBUTE
public static final int QUERY_TYPE_ANCESTORS
public static final int QUERY_TYPE_DTSMEMBERS
public static final int QUERY_TYPE_DIMUSERATTRIBUTES
public static final int QUERY_OPTION_MEMBERSONLY
public static final int QUERY_OPTION_ALIASESONLY
public static final int QUERY_OPTION_MEMBERSANDALIASES
public static final int QUERY_OPTION_COUNTONLY
Method Detail |
public java.lang.String getName() throws EssException
getName
in interface IEssExtendedObject
EssException
- if an error occurs.public void open() throws EssException
EssException
- if an error occurs.public void close() throws EssException
EssException
- if an error occurs.public void executeQuery(java.lang.String memberName) throws EssException
memberName
- The member name.
EssException
- if an error occurs.public void executeQuery(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2) throws EssException
mbrName
- The name of the member to do the operation on.
If this value is null, it is assumed to be the very top of the outline,
representing the logical parent of the dimensions. This value will be
ignored for the following query types (specified by queryType param):
QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_USERATTRIBUTE,
QUERY_TYPE_SEARCH, QUERY_TYPE_WILDSEARCH.queryType
- Type of the query. Value defining the operation to perform.
It can be one of the following: QUERY_TYPE_CHILDREN, QUERY_TYPE_DESCENDANTS,
QUERY_TYPE_BOTTOMLEVEL, QUERY_TYPE_SIBLINGS, QUERY_TYPE_SAMELEVEL,
QUERY_TYPE_SAMEGENERATION, QUERY_TYPE_PARENT, QUERY_TYPE_DIMENSION,
QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_SEARCH,
QUERY_TYPE_WILDSEARCH, QUERY_TYPE_USERATTRIBUTE, QUERY_TYPE_ANCESTORS,
QUERY_TYPE_DTSMEMBERS, QUERY_TYPE_DIMUSERATTRIBUTES.queryOptions
- Options dependent on the query type.
For the query types (specified via queryType param) QUERY_TYPE_SEARCH/
QUERY_TYPE_WILDSEARCH you can specify one of the following query options:
QUERY_OPTION_MEMBERSONLY, QUERY_OPTION_ALIASESONLY,
QUERY_OPTION_MEMBERSANDALIASES. With any of the option, you can combine
QUERY_OPTION_COUNTONLY to get the count only.dimName
- Dimension to limit the scope of the query.
It is used with the following query options and ignored otherwise:
QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_USERATTRIBUTE
QUERY_TYPE_SEARCH (set to NULL to search through all dimensions),
QUERY_TYPE_WILDSEARCH (set to NULL to search through all dimensions).input1
- Input string that is determined by the option.
It is used with the following query options and ignored otherwise:
QUERY_TYPE_NAMEDGENERATION (The name of the generation),
QUERY_TYPE_NAMEDLEVEL (The name of the level),
QUERY_TYPE_SEARCH (The string to search for. The string is defined as an
exact), QUERY_TYPE_WILDSEARCH (The string to search for. The string is
defined as an exact search string with an optional '*' at the end to mean
any set of characters), QUERY_TYPE_USERATTRIBUTE (The user defined attribute).input2
- Input string that is determined by the option.
It is used with the following query options and ignored otherwise:
QUERY_TYPE_USERATTRIBUTE (The user defined attribute), QUERY_TYPE_SEARCH,
QUERY_TYPE_WILDSEARCH (If the options are set to look in the alias tables,
this string specifies the alias table to search in. If it's null, all
alias tables will be searched).
EssException
- if an error occurs.public void executeQuery(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2, int startMemberIndex, int maxMemberCount) throws EssException
int total = 0; IEssIterator mbrs = null; do { memberSelection.executeQuery(... , total, 100); mbrs = mbrSel.getMembers(); if(mbrs != null) { // add results to result list, process the result total += mbrs.getCount(); } } while( (total <= 1000) && (mbrs != null && mbrs.getCount() > 0) );
mbrName
- The name of the member to do the operation on.
If this value is null, it is assumed to be the very top of the outline,
representing the logical parent of the dimensions. This value will be
ignored for the following query types (specified by queryType param):
QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_USERATTRIBUTE,
QUERY_TYPE_SEARCH, QUERY_TYPE_WILDSEARCH.queryType
- Type of the query. Value defining the operation to perform.
It can be one of the following: QUERY_TYPE_CHILDREN, QUERY_TYPE_DESCENDANTS,
QUERY_TYPE_BOTTOMLEVEL, QUERY_TYPE_SIBLINGS, QUERY_TYPE_SAMELEVEL,
QUERY_TYPE_SAMEGENERATION, QUERY_TYPE_PARENT, QUERY_TYPE_DIMENSION,
QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_SEARCH,
QUERY_TYPE_WILDSEARCH, QUERY_TYPE_USERATTRIBUTE, QUERY_TYPE_ANCESTORS,
QUERY_TYPE_DTSMEMBERS, QUERY_TYPE_DIMUSERATTRIBUTES.queryOptions
- Options dependent on the query type.
For the query types (specified via queryType param) QUERY_TYPE_SEARCH/
QUERY_TYPE_WILDSEARCH you can specify one of the following query options:
QUERY_OPTION_MEMBERSONLY, QUERY_OPTION_ALIASESONLY,
QUERY_OPTION_MEMBERSANDALIASES. With any of the option, you can combine
QUERY_OPTION_COUNTONLY to get the count only.dimName
- Dimension to limit the scope of the query.
It is used with the following query options and ignored otherwise:
QUERY_TYPE_NAMEDGENERATION, QUERY_TYPE_NAMEDLEVEL, QUERY_TYPE_USERATTRIBUTE
QUERY_TYPE_SEARCH (set to NULL to search through all dimensions),
QUERY_TYPE_WILDSEARCH (set to NULL to search through all dimensions).input1
- Input string that is determined by the option.
It is used with the following query options and ignored otherwise:
QUERY_TYPE_NAMEDGENERATION (The name of the generation),
QUERY_TYPE_NAMEDLEVEL (The name of the level),
QUERY_TYPE_SEARCH (The string to search for. The string is defined as an
exact), QUERY_TYPE_WILDSEARCH (The string to search for. The string is
defined as an exact search string with an optional '*' at the end to mean
any set of characters), QUERY_TYPE_USERATTRIBUTE (The user defined attribute).input2
- Input string that is determined by the option.
It is used with the following query options and ignored otherwise:
QUERY_TYPE_USERATTRIBUTE (The user defined attribute), QUERY_TYPE_SEARCH,
QUERY_TYPE_WILDSEARCH (If the options are set to look in the alias tables,
this string specifies the alias table to search in. If it's null, all
alias tables will be searched).startMemberIndex
- Defines where (in a large result set)to start
getting the members from.maxMemberCount
- Defines how many members to get at a time. The
resulting member count will be at the most this value.
EssException
- if an error occurs.public void executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection) throws EssException
fieldSelection
- The query string which defines the set of fields
that will be returned for each member. The syntax is "mbrSelection
- The query string which defines the set of members to
be returned. The syntax of this query string is the syntax for member
selection; that is, the query string can be anything that you can use in
a FIX() statement.
EssException
- if an error occurs.public int getCountMembers() throws EssException
EssException
- if an error occurs.public IEssIterator getMembers() throws EssException
EssException
public IEssCube getCube() throws EssException
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |