|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssMemberSelection
The IEssMemberSelection interface.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties |
---|
IEssProperties.EEssPropertyMode |
Method Summary | |
---|---|
void |
close() Closes the member selection. |
IEssAttributeQuery |
createAttributeQuery() Creates an Attribute Query Specifier instance and returns the same. |
IEssVaryingAttributeQuery |
createVaryingAttributeQuery() Creates an Varying Attribute Query Specifier instance and returns the same. |
void |
executeQuery(java.lang.String memberName) Executes 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. |
void |
executeQuery(java.lang.String fieldSelection, java.lang.String[] mbrSelection, int[] maxMemberCount) Executes the list of member selection queries specified. |
void |
executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection, int maxMemberCount) Executes the member selection query. |
java.lang.String[] |
getAliasTableNames() Gets the names of alias tables existing in the outline. |
int |
getBucketingType() Gets the numeric attribute's bucketing type. |
int |
getCountAliasTables() Gets the count of alias tables existing in the outline. |
int |
getCountEnabledDTSMembers() Gets the count of defined DTS members for the outline. |
int |
getCountMembers() Gets the count of resulting members. |
int |
getCountMembers(int queryIndex) Gets the count of resulting members for the query specified by query index. |
IEssCube |
getCube() Gets the parent cube. |
int |
getDateFormat() Gets the format for a datetime attribute. |
java.lang.String |
getDefaultAttrCalcDimName() Gets the name of the attribute calculations (aggregate) dimension. |
java.lang.String |
getDefaultAverageMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate AVERAGE. |
java.lang.String |
getDefaultCountMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate COUNT. |
java.lang.String |
getDefaultFalseString() Gets the string used with the boolean attribute to indicate false. |
java.lang.String |
getDefaultMaxMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate MAXIMUM. |
java.lang.String |
getDefaultMinMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate MINIMUM. |
java.lang.String |
getDefaultSumMbrName() Gets the name used with the attribute calculations (aggregate) dimension to indicate SUM. |
java.lang.String |
getDefaultTrueString() Gets the string used with the boolean attribute to indicate true. |
int |
getDelimiter() Gets the delimiter to use when generating a long name. |
IEssIterator |
getDimensionGenerations(java.lang.String dimensionName) Gets all the generations for the given dimension. |
IEssIterator |
getDimensionLevels(java.lang.String dimensionName) Gets all the levels for the given dimension. |
java.lang.String[] |
getDimensionUDAs(java.lang.String dimensionName) Gets all the User Defined Attributes (used by one or more members) for the given dimension. |
java.lang.String |
getDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName) Deprecated. Essbase does not support this API in query mode |
java.lang.String |
getEnabledDTSMember(int index) Gets the defined DTS member name for the outline at the specified index. |
int |
getGenerationForEnabledDTSMember(int index) Gets the generation for the defined DTS member name for the outline at the specified index. |
IEssIterator |
getMembers() Gets the resulting members. |
IEssIterator |
getMembers(int queryIndex) Gets the resulting members for the query specified by query index. |
java.lang.String |
getName() Gets the name of the member selection. |
IEssCube.EEssCubeType |
getOutlineType() Gets the outline type. |
IEssCube.EEssTimePeriod[] |
getTimePeriods(java.lang.String dateTimeDimTopMember, int tiDimQueryID) In a time dimension hierarchy, members falling under same generation come from same time period domain. |
int |
getUseNameOf() Gets which generation(s) of the zero-level member to use when generating a long name. |
boolean |
isAutoConfigure() Checks if to automatically configure the dimension storage(dense/sparse) when the outline is saved. |
boolean |
isCaseSensitive() Checks if the member names are case-sensitive. |
boolean |
isGenerationNameByPrefix() Checks if to use the generation(s) of the zero-level member as the prefix or the suffix when generating a long name. |
boolean |
isMemberTypeEnabled() Indicates if the outline supports different Member types such as Smartlist & Date type of members & cells. |
boolean |
isNonUniqueMemberNameEnabled() Checks if Non Unique Member Names are allowed in this outline. |
boolean |
isVaryingAttributeEnabled() Indicates if the outline is enabled to have Varying Attributes. |
void |
open() Opens the member selection. |
IEssMember[] |
queryAttributes(IEssAttributeQuery queryDefn) Performs an attribute query based on the given Attribute Query specification. |
IEssMember[] |
queryVaryingAttributes(IEssVaryingAttributeQuery queryDefn) Returns the members that matches the conditions specified through the varying attribute query. |
IEssMemberWithIndepMbrsSet[] |
queryVaryingAttributes(IEssVaryingAttributeQuery queryDefn, short typeOfIndepMbrsSetExpected) Returns the Members with its associated Independent members set, based on the specified the varying attribute query. |
void |
refreshPropertyValues() Refreshes the property values. |
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, setPropertyValueAny, setPropertyValueAny, updatePropertyValues |
Field Detail |
---|
static final int QUERY_TYPE_CHILDREN
static final int QUERY_TYPE_DESCENDANTS
static final int QUERY_TYPE_BOTTOMLEVEL
static final int QUERY_TYPE_SIBLINGS
static final int QUERY_TYPE_SAMELEVEL
static final int QUERY_TYPE_SAMEGENERATION
static final int QUERY_TYPE_PARENT
static final int QUERY_TYPE_DIMENSION
static final int QUERY_TYPE_NAMEDGENERATION
static final int QUERY_TYPE_NAMEDLEVEL
static final int QUERY_TYPE_SEARCH
static final int QUERY_TYPE_WILDSEARCH
static final int QUERY_TYPE_USERATTRIBUTE
static final int QUERY_TYPE_ANCESTORS
static final int QUERY_TYPE_DTSMEMBERS
static final int QUERY_TYPE_DIMUSERATTRIBUTES
static final int QUERY_TYPE_INDEPDIMS
static final int QUERY_TYPE_INDEPDIMS_DISCRETE
static final int QUERY_TYPE_INDEPDIMS_CONTINUOUS
static final int QUERY_OPTION_MEMBERSONLY
static final int QUERY_OPTION_ALIASESONLY
static final int QUERY_OPTION_MEMBERSANDALIASES
static final int QUERY_OPTION_COUNTONLY
static final int QUERY_OPTION_INCLUDEHYBRIDANALYSIS
static final int QUERY_OPTION_EXCLUDEHYBRIDANALYSIS
static final int QUERY_OPTION_FORCECASESENSITIVE
static final int QUERY_OPTION_FORCEIGNORECASE
static final int QUERY_OPTION_NOTOTALCOUNTS
static final int QUERY_OPTION_UNIQUENAME
static final int QUERY_OPTION_USESUBSTITUTIONVAR
static final int QUERY_TIDIM_TIMEPERIODS
Method Detail |
---|
java.lang.String getName() throws com.essbase.api.base.EssException
getName
in interface IEssExtendedObject
com.essbase.api.base.EssException
- if an error occurs.void open() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void close() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void executeQuery(java.lang.String memberName) throws com.essbase.api.base.EssException
memberName
- The member name.com.essbase.api.base.EssException
- if an error occurs.void executeQuery(java.lang.String mbrName, int queryType, int queryOptions, java.lang.String dimName, java.lang.String input1, java.lang.String input2) throws com.essbase.api.base.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_INDEPDIMS, QUERY_TYPE_INDEPDIMS_DISCRETE, QUERY_TYPE_INDEPDIMS_CONTINUOUS.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 query type, you can combine QUERY_OPTION_COUNTONLY, QUERY_OPTION_NOTOTALCOUNTS QUERY_OPTION_INCLUDEHYBRIDANALYSIS, QUERY_OPTION_EXCLUDEHYBRIDANALYSIS, QUERY_OPTION_FORCECASESENSITIVE, QUERY_OPTION_FORCEIGNORECASE, QUERY_OPTION_UNIQUENAME, QUERY_OPTION_USESUBSTITUTIONVAR.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).com.essbase.api.base.EssException
- if an error occurs.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 com.essbase.api.base.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.queryType
- Type of the query. Value defining the operation to perform.queryOptions
- Options dependent on the query type.dimName
- Dimension to limit the scope of the query.input1
- Input string that is determined by the option.input2
- Input string that is determined by the option. See executeQuery(String mbrName, int queryType, int queryOptions, String dimName, String input1, String input)
for details of parameters listed above.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.com.essbase.api.base.EssException
- if an error occurs.void executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection) throws com.essbase.api.base.EssException
executeQuery("<OutputType Binary <SelectMbrInfo (MemberName, MemberLevel, Consolidation, MemberFormula )", "@ichild(Product), @ichild(Market)");
fieldSelection
- The query string which defines the set of fields that will be returned for each member. The syntax is "<OutputType Binary | Text <SelectMbrInfo ( FieldName {, FieldName}, ... )" where FieldName is one of the following: MemberName (Member name), MemberLevel (Member level number), MemberGeneration (Member generation number), Consolidation (Whether this member is consolidated), TwoPass (Whether this member undergoes a two pass operation), Expense (Whether this is an expense member), CurrencyConvType (Currency conversion type), CurrencyMember (Whether this is a currency member), TimeBalance (Time balance measure), SkipOption (Whether this member skips the time balance operation), ShareOption (Whether this is a shared member), StorageType (Dimension's storage type), DimensionCategory (Dimension category: accounts, time, currency, etc.), DimensionStorageCategory (Dimension storage category: time, units, scenario, etc.), Comment (Member comment), ChildrenCount (Number of children), MemberNumber (Member number), DimensionName (Dimension name), DimensionNumber (Dimension number), MemberAliasName (Alias for this member), ParentMemberName (Parent's name), ChildMemberName (Child's name), PreviousMemberName (Left sibling's name), NextMemberName (Right sibling's name), CurrencyConversionDatabase (Whether this database has currency conversion), MemberStatus (Member status), UDAList (List of UDAs attached to this member), MemberFormula (Formula for this member), MemberValidity (Whether this member is valid), AttrDimensionNames (Attribute dimensions associated with this member's dimension), MemberAttributed (Whether this member is attributed), AttributeDataType (Attribute data type for this member), AttributeDataValue (Attribute data value for this member), FormatString (Format String associated with this member).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.com.essbase.api.base.EssException
- if an error occurs.void executeQuery(java.lang.String fieldSelection, java.lang.String mbrSelection, int maxMemberCount) throws com.essbase.api.base.EssException
executeQuery("<OutputType Binary <SelectMbrInfo (MemberName, MemberLevel, Consolidation, MemberFormula )", "@ichild(Product), @ichild(Market)");
fieldSelection
- The query string which defines the set of fields that will be returned for each member.mbrSelection
- The query string which defines the set of members to be returned. See executeQuery(String fieldSelection, String mbrSelection)
for details of parameters listed above.maxMemberCount
- Defines how many members to get at the most. The resulting member count will be at the most this value.com.essbase.api.base.EssException
- if an error occurs.void executeQuery(java.lang.String fieldSelection, java.lang.String[] mbrSelection, int[] maxMemberCount) throws com.essbase.api.base.EssException
getCountMembers(int)
and getMembers(int)
to fetch the results of individual queries. NOTE: If you invoke executeQuery multiple times, make sure to get the resulting member objects and use those, and discard the members objects obtained from prior executeQuery results.fieldSelection
- The query string which defines the set of fields that will be returned for each member.mbrSelection
- an array of query string which defines the set of members to be returned. See executeQuery(String fieldSelection, String mbrSelection)
for details of parameters listed above.maxMemberCount
- Defines how many members to get at the most. The resulting member count will be at the most this value.com.essbase.api.base.EssException
- if an error occurs.int getCountMembers() throws com.essbase.api.base.EssException
executeQuery(String, String[], int[])
, the count will return consolidated count of members from all the queries.com.essbase.api.base.EssException
- if an error occurs.int getCountMembers(int queryIndex) throws com.essbase.api.base.EssException
queryIndex
- index of the member selection query specified in executeQuery(String, String[], int[])
com.essbase.api.base.EssException
- if an error occurs.IEssIterator getMembers() throws com.essbase.api.base.EssException
executeQuery(String, String[], int[])
, all the members from all the queries will be returned.com.essbase.api.base.EssException
IEssIterator getMembers(int queryIndex) throws com.essbase.api.base.EssException
queryIndex
- index of the member selection query specified in executeQuery(String, String[], int[])
com.essbase.api.base.EssException
- if an error occurs.IEssCube getCube() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isCaseSensitive() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isAutoConfigure() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isNonUniqueMemberNameEnabled() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isMemberTypeEnabled() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isVaryingAttributeEnabled() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssCube.EEssCubeType getOutlineType() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getCountAliasTables() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String[] getAliasTableNames() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.boolean isGenerationNameByPrefix() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getUseNameOf() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getDelimiter() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getDateFormat() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.int getBucketingType() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultTrueString() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultFalseString() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultAttrCalcDimName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultSumMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultCountMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultAverageMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultMinMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDefaultMaxMbrName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDTSMemberAlias(java.lang.String dtsMemberName, java.lang.String aliasTableName) throws com.essbase.api.base.EssException
dtsMemberName
- The DTS member name which provides the alias.aliasTableName
- The alias table name which provides the alias. If null, the default alias table is usedcom.essbase.api.base.EssException
- if an error occurs.IEssCubeOutline.getDTSMemberAlias(String, String)
int getCountEnabledDTSMembers() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getEnabledDTSMember(int index) throws com.essbase.api.base.EssException
index
- The index where to get the DTS member from. This should be between 0 and the value returned by getCountEnabledDTSMembers().com.essbase.api.base.EssException
- if an error occurs.int getGenerationForEnabledDTSMember(int index) throws com.essbase.api.base.EssException
index
- The index where to get the DTS member from. This should be between 0 and the value returned by getCountEnabledDTSMembers().com.essbase.api.base.EssException
- if an error occurs.IEssIterator getDimensionGenerations(java.lang.String dimensionName) throws com.essbase.api.base.EssException
dimensionName
- The dimension name.com.essbase.api.base.EssException
- if an error occurs.IEssIterator getDimensionLevels(java.lang.String dimensionName) throws com.essbase.api.base.EssException
dimensionName
- The dimension name.com.essbase.api.base.EssException
- if an error occurs.java.lang.String[] getDimensionUDAs(java.lang.String dimensionName) throws com.essbase.api.base.EssException
dimensionName
- The dimension name.com.essbase.api.base.EssException
- if an error occurs.IEssCube.EEssTimePeriod[] getTimePeriods(java.lang.String dateTimeDimTopMember, int tiDimQueryID) throws com.essbase.api.base.EssException
dateTimeDimTopMember
- The dimension name.tiDimQueryID
- Time Intelligence related query id. Any possible QUERY_TIDIM_*.com.essbase.api.base.EssException
- if an error occurs.void refreshPropertyValues() throws com.essbase.api.base.EssException
refreshPropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.IEssAttributeQuery createAttributeQuery() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssVaryingAttributeQuery createVaryingAttributeQuery() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssMember[] queryAttributes(IEssAttributeQuery queryDefn) throws com.essbase.api.base.EssException
queryDefn
- Attribute Query used to filter and return the appropriate members.com.essbase.api.base.EssException
- if an error occurs.IEssMember[] queryVaryingAttributes(IEssVaryingAttributeQuery queryDefn) throws com.essbase.api.base.EssException
queryDefn
- Varying Attribute Query used to filter and retrieve the appropriate members.com.essbase.api.base.EssException
- if an error occurs.IEssMemberWithIndepMbrsSet[] queryVaryingAttributes(IEssVaryingAttributeQuery queryDefn, short typeOfIndepMbrsSetExpected) throws com.essbase.api.base.EssException
The type of Independent Members Set will be based on what type of Independent Members Set you want as part of the output, which has to be, one of the below only:
IEssVaryingAttributeQuery.INDEP_MEMBERSET_TYPE_MEMBER_REF
IEssVaryingAttributeQuery.INDEP_MEMBERSET_TYPE_MEMBER_NAME
queryDefn
- Varying Attribute Query used to filter and retrieve the appropriate members.typeOfIndepMbrsSetExpected
- type of Independent Members Set expected (one of IEssVaryingAttributeQuery.INDEP_MEMBERSET_TYPE_MEMBER_*
)com.essbase.api.base.EssException
- if an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |