Skip navigation links


com.essbase.eas.essbase.server.outline
Class ViewPrimitives

java.lang.Object
  extended by com.essbase.eas.essbase.server.outline.ViewPrimitives


public class ViewPrimitives
extends java.lang.Object

This class provides the primitive operations for an Essbase outline viewer.


Method Summary
static boolean findMember(EssSession session, Identifier identifier, java.lang.String searchText, java.lang.String aliasTable, boolean matchCase, boolean matchWord, java.util.Collection c, java.util.Collection errors)
          Uses Outline Query API to find members using a wildcard search and an optional alias table
static boolean findRequest(EssSession session, FindRequest request, Identifier identifier, java.util.Collection c, java.util.Collection errors)
           
static boolean findRequestFile(EssSession session, FindRequest request, Identifier identifier, java.lang.String dataPath, java.lang.String indexPath, java.util.Collection errors)
           
static boolean getAllSmartlistsQuery(EssSession session, java.util.ArrayList list, java.util.ArrayList mappingList, java.util.Collection errors)
           
static java.util.List getAttributeDimensions(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dimension)
          returns the names of the dimension attributes.
static boolean getAttributeSpecs(EssSession session, Identifier identifier, DefaultAttributeSpecs specs, java.util.Collection errors)
          returns the attribute specs for an outline.
static java.util.List getCellCount(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String cellRef)
           
static int getChildMemberIndex(EssSession session, java.lang.String dimension, java.lang.String parentName, java.lang.String member, int startSearchIndex, int endSearchIndex)
           
static boolean getChildren(EssSession session, Identifier identifier, java.lang.String dimension, java.lang.String parentName, java.util.Collection c, java.util.Collection errors)
          gets the set of children for a member in the outline.
static java.util.List getChildren(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dimension, java.lang.String member)
          returns the names of the children of a member.
static java.util.List getChildren(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dimension, java.lang.String member, java.lang.String aliastbl)
          returns the names of the children of a member.
static java.io.File getChildrenAsFile(EssSession session, Identifier identifier, java.lang.String dimension, java.lang.String parentName, java.util.Collection errors)
          gets the set of children for a member in the outline.
static java.io.File getChildrenAsFile(EssSession session, Identifier identifier, java.lang.String dimension, java.lang.String parentName, int startIndex, int maxCount, java.util.Collection errors)
          gets the set of children for a member in the outline when outline is opened as a file.
static boolean getChildrenAsFile(Identifier identifier, java.lang.String dimension, java.lang.String parentName, long parentHandle, int startIndex, int maxCount, java.lang.String fileName, java.util.Collection errors)
          gets the set of children for a member in the outline.
static java.util.List getChildrenWithProperties(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dimension, java.lang.String member, long startWith, int atMost)
          returns a list containing the member information structures for the children of a member.
static DimensionInformation getDimensionInformation(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dimension)
           
static boolean getDimensions(EssSession session, Identifier identifier, java.util.Collection c, java.util.Collection errors)
          gets the set of dimensions for the outline.
static java.util.List getDimensions(EssSession session, java.lang.String appName, java.lang.String dbName)
          returns the names of the dimensions associated with an outline.
static java.util.List getDimensions(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String aliastbl)
          returns the names of the dimensions associated with an outline.
static boolean getDimensionUDAS(EssSession session, Identifier identifier, java.lang.String memberName, java.util.Set s, java.util.Collection errors)
          gets the user defined attributes (UDAS) for all members of a dimension
static java.util.List getDimensionUserAttributes(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dimension)
          returns the names of the dimension attributes.
static boolean getDTSMembers(EssSession session, Identifier identifier, java.util.Collection dts, java.util.Collection errors)
          gets enabled DTS members for an outline
static java.util.List getDTSMembers(EssSession session, java.lang.String appName, java.lang.String dbName)
           
static java.util.List getFindMemberList(OutlineHandle outlineHandle, java.lang.String mbrName, java.lang.String searchStr, boolean useAliases, java.lang.String aliasTableName)
           
static boolean getGenerations(EssSession session, Identifier identifier, java.util.Collection generations, java.util.Collection errors)
          gets the generations for an outline
static java.util.List getGenerations(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dimension)
          returns the names of the children of a member.
static java.util.List getLatestDTSNames(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dimension, java.lang.String aliastbl)
          returns the names of the children of a member.
static boolean getLevels(EssSession session, Identifier identifier, java.util.Collection levels, java.util.Collection errors)
          gets defined levels for an outline
static java.util.List getLevels(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dimension)
          returns the names of the children of a member.
static boolean getMemberAliases(EssSession session, Identifier identifier, java.lang.String memberName, java.util.Collection c, java.util.Collection errors)
          gets the aliases for a member
static boolean getMemberAliasesBlock(EssSession session, Identifier identifier, MemberRequestItem[] theRequests, java.util.Collection c, java.util.Collection errors)
           
static boolean getMemberAncestors(EssSession session, java.lang.String memberName, java.util.Collection c, java.util.Collection errors)
           
static boolean getMemberAncestorsEx(EssSession session, java.lang.String memberName, java.util.Collection c, java.util.Collection errors)
           
static boolean getMemberAttributes(EssSession session, Identifier identifier, java.lang.String memberName, java.util.Collection c, java.util.Collection errors)
          gets the attributes for a member
static boolean getMemberAttributesBlock(EssSession session, Identifier identifier, MemberRequestItem[] theRequests, java.util.Collection c, java.util.Collection errors)
           
static boolean getMemberFormula(EssSession session, Identifier identifier, java.lang.String memberName, Formula f, java.util.Collection errors)
          gets the formula for a member
static boolean getMemberFormulaBlock(EssSession session, Identifier identifier, MemberRequestItem[] theRequests, java.util.Collection c, java.util.Collection errors)
           
static OutlineMemberProperties getMemberProperties(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String member)
           
static boolean getMemberTypeQuery(EssSession session, java.lang.String memberName, MemberType type, java.util.Collection errors)
           
static boolean getMemberUDAS(EssSession session, Identifier identifier, java.lang.String memberName, java.util.Collection c, java.util.Collection errors)
          gets the user defined attributes (UDAS) for a member
static boolean getMemberUDASBlock(EssSession session, Identifier identifier, MemberRequestItem[] theRequests, java.util.Collection c, java.util.Collection errors)
           
static int getOutlineInfo(OutlineHandle outlineHandle, OutlineInfo info)
           
static java.util.List getOutlineMemberList(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String mbrName, boolean useAliases, java.lang.String aliasTableName)
           
static OutlineProperties getProperties(EssSession session, java.lang.String appName, java.lang.String dbName)
          returns the properties associated with an outline object.
static boolean getQueryHints(EssSession session, Identifier identifier, java.util.Collection errors, short numMembers, java.util.ArrayList queryHints)
          returns the query hints for an outline.
static int getServerDateFormats(EssSession session, java.util.ArrayList dateFormats, java.util.ArrayList dateStrings)
           
static boolean getSettings(EssSession session, Identifier identifier, DefaultSettings settings, java.util.Collection errors)
          returns the settings for an outline.
static boolean getSmartlist(EssSession session, long memberHandle, java.util.ArrayList list, java.util.ArrayList mappingList, java.util.Collection errors)
           
static boolean getSmartlistFromMemberName(EssSession session, java.lang.String memberName, java.util.ArrayList list, java.util.Collection errors)
           
static boolean getVaryingAttributeIndependentDimensionsQuery(EssSession session, java.lang.String attr, java.util.Collection indepMemHandle, java.util.Collection errors)
           
static boolean getVaryingMemberAttributesQuery(EssSession session, java.lang.String baseMember, java.lang.String baseDimension, java.lang.String attrDim, java.util.ArrayList perspectiveList, boolean needValiditySet, java.util.Collection indepDimNames, java.util.Collection errors)
           
static boolean initializeViewer(EssSession session, Identifier identifier, java.util.List dimensions, java.util.List dts, AttributeSpecs specs, Settings settings, java.util.Collection errors)
           
static boolean openOutlineQuery(EssSession session, OutlineJni outlineJni, Identifier identifier, OutlineHandle outlineHandle)
           
static boolean openOutlineQuery(EssSession session, OutlineJni outlineJni, Identifier identifier, OutlineHandle outlineHandle, java.util.Collection errors)
           

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Method Detail

openOutlineQuery

public static boolean openOutlineQuery(EssSession session,
                                       OutlineJni outlineJni,
                                       Identifier identifier,
                                       OutlineHandle outlineHandle)

openOutlineQuery

public static boolean openOutlineQuery(EssSession session,
                                       OutlineJni outlineJni,
                                       Identifier identifier,
                                       OutlineHandle outlineHandle,
                                       java.util.Collection errors)

getProperties

public static OutlineProperties getProperties(EssSession session,
                                              java.lang.String appName,
                                              java.lang.String dbName)
returns the properties associated with an outline object.

getDimensions

public static java.util.List getDimensions(EssSession session,
                                           java.lang.String appName,
                                           java.lang.String dbName)
returns the names of the dimensions associated with an outline.

getDimensions

public static java.util.List getDimensions(EssSession session,
                                           java.lang.String appName,
                                           java.lang.String dbName,
                                           java.lang.String aliastbl)
returns the names of the dimensions associated with an outline.

getChildrenAsFile

public static java.io.File getChildrenAsFile(EssSession session,
                                             Identifier identifier,
                                             java.lang.String dimension,
                                             java.lang.String parentName,
                                             java.util.Collection errors)
gets the set of children for a member in the outline.

getChildrenAsFile

public static java.io.File getChildrenAsFile(EssSession session,
                                             Identifier identifier,
                                             java.lang.String dimension,
                                             java.lang.String parentName,
                                             int startIndex,
                                             int maxCount,
                                             java.util.Collection errors)
gets the set of children for a member in the outline when outline is opened as a file.

getChildrenAsFile

public static boolean getChildrenAsFile(Identifier identifier,
                                        java.lang.String dimension,
                                        java.lang.String parentName,
                                        long parentHandle,
                                        int startIndex,
                                        int maxCount,
                                        java.lang.String fileName,
                                        java.util.Collection errors)
gets the set of children for a member in the outline.

getChildren

public static java.util.List getChildren(EssSession session,
                                         java.lang.String appName,
                                         java.lang.String dbName,
                                         java.lang.String dimension,
                                         java.lang.String member)
returns the names of the children of a member.

getChildren

public static java.util.List getChildren(EssSession session,
                                         java.lang.String appName,
                                         java.lang.String dbName,
                                         java.lang.String dimension,
                                         java.lang.String member,
                                         java.lang.String aliastbl)
returns the names of the children of a member.

getChildrenWithProperties

public static java.util.List getChildrenWithProperties(EssSession session,
                                                       java.lang.String appName,
                                                       java.lang.String dbName,
                                                       java.lang.String dimension,
                                                       java.lang.String member,
                                                       long startWith,
                                                       int atMost)
returns a list containing the member information structures for the children of a member.

getMemberProperties

public static OutlineMemberProperties getMemberProperties(EssSession session,
                                                          java.lang.String appName,
                                                          java.lang.String dbName,
                                                          java.lang.String member)

getGenerations

public static java.util.List getGenerations(EssSession session,
                                            java.lang.String appName,
                                            java.lang.String dbName,
                                            java.lang.String dimension)
returns the names of the children of a member.

getDimensionUserAttributes

public static java.util.List getDimensionUserAttributes(EssSession session,
                                                        java.lang.String appName,
                                                        java.lang.String dbName,
                                                        java.lang.String dimension)
returns the names of the dimension attributes.

getAttributeDimensions

public static java.util.List getAttributeDimensions(EssSession session,
                                                    java.lang.String appName,
                                                    java.lang.String dbName,
                                                    java.lang.String dimension)
returns the names of the dimension attributes.

getDimensionInformation

public static DimensionInformation getDimensionInformation(EssSession session,
                                                           java.lang.String appName,
                                                           java.lang.String dbName,
                                                           java.lang.String dimension)

getLevels

public static java.util.List getLevels(EssSession session,
                                       java.lang.String appName,
                                       java.lang.String dbName,
                                       java.lang.String dimension)
returns the names of the children of a member.

getDTSMembers

public static java.util.List getDTSMembers(EssSession session,
                                           java.lang.String appName,
                                           java.lang.String dbName)

getLatestDTSNames

public static java.util.List getLatestDTSNames(EssSession session,
                                               java.lang.String appName,
                                               java.lang.String dbName,
                                               java.lang.String dimension,
                                               java.lang.String aliastbl)
returns the names of the children of a member.

getCellCount

public static java.util.List getCellCount(EssSession session,
                                          java.lang.String appName,
                                          java.lang.String dbName,
                                          java.lang.String cellRef)

getOutlineMemberList

public static java.util.List getOutlineMemberList(EssSession session,
                                                  java.lang.String appName,
                                                  java.lang.String dbName,
                                                  java.lang.String mbrName,
                                                  boolean useAliases,
                                                  java.lang.String aliasTableName)

getFindMemberList

public static java.util.List getFindMemberList(OutlineHandle outlineHandle,
                                               java.lang.String mbrName,
                                               java.lang.String searchStr,
                                               boolean useAliases,
                                               java.lang.String aliasTableName)

findMember

public static boolean findMember(EssSession session,
                                 Identifier identifier,
                                 java.lang.String searchText,
                                 java.lang.String aliasTable,
                                 boolean matchCase,
                                 boolean matchWord,
                                 java.util.Collection c,
                                 java.util.Collection errors)
Uses Outline Query API to find members using a wildcard search and an optional alias table

getSettings

public static boolean getSettings(EssSession session,
                                  Identifier identifier,
                                  DefaultSettings settings,
                                  java.util.Collection errors)
returns the settings for an outline.

getQueryHints

public static boolean getQueryHints(EssSession session,
                                    Identifier identifier,
                                    java.util.Collection errors,
                                    short numMembers,
                                    java.util.ArrayList queryHints)
returns the query hints for an outline.

getAttributeSpecs

public static boolean getAttributeSpecs(EssSession session,
                                        Identifier identifier,
                                        DefaultAttributeSpecs specs,
                                        java.util.Collection errors)
returns the attribute specs for an outline.

getDimensions

public static boolean getDimensions(EssSession session,
                                    Identifier identifier,
                                    java.util.Collection c,
                                    java.util.Collection errors)
gets the set of dimensions for the outline.

getChildren

public static boolean getChildren(EssSession session,
                                  Identifier identifier,
                                  java.lang.String dimension,
                                  java.lang.String parentName,
                                  java.util.Collection c,
                                  java.util.Collection errors)
gets the set of children for a member in the outline.

getMemberFormula

public static boolean getMemberFormula(EssSession session,
                                       Identifier identifier,
                                       java.lang.String memberName,
                                       Formula f,
                                       java.util.Collection errors)
gets the formula for a member

getMemberAliases

public static boolean getMemberAliases(EssSession session,
                                       Identifier identifier,
                                       java.lang.String memberName,
                                       java.util.Collection c,
                                       java.util.Collection errors)
gets the aliases for a member

getMemberAttributes

public static boolean getMemberAttributes(EssSession session,
                                          Identifier identifier,
                                          java.lang.String memberName,
                                          java.util.Collection c,
                                          java.util.Collection errors)
gets the attributes for a member

getMemberUDAS

public static boolean getMemberUDAS(EssSession session,
                                    Identifier identifier,
                                    java.lang.String memberName,
                                    java.util.Collection c,
                                    java.util.Collection errors)
gets the user defined attributes (UDAS) for a member

getDimensionUDAS

public static boolean getDimensionUDAS(EssSession session,
                                       Identifier identifier,
                                       java.lang.String memberName,
                                       java.util.Set s,
                                       java.util.Collection errors)
gets the user defined attributes (UDAS) for all members of a dimension

getGenerations

public static boolean getGenerations(EssSession session,
                                     Identifier identifier,
                                     java.util.Collection generations,
                                     java.util.Collection errors)
gets the generations for an outline

getLevels

public static boolean getLevels(EssSession session,
                                Identifier identifier,
                                java.util.Collection levels,
                                java.util.Collection errors)
gets defined levels for an outline

getDTSMembers

public static boolean getDTSMembers(EssSession session,
                                    Identifier identifier,
                                    java.util.Collection dts,
                                    java.util.Collection errors)
gets enabled DTS members for an outline

getMemberAliasesBlock

public static boolean getMemberAliasesBlock(EssSession session,
                                            Identifier identifier,
                                            MemberRequestItem[] theRequests,
                                            java.util.Collection c,
                                            java.util.Collection errors)

getMemberUDASBlock

public static boolean getMemberUDASBlock(EssSession session,
                                         Identifier identifier,
                                         MemberRequestItem[] theRequests,
                                         java.util.Collection c,
                                         java.util.Collection errors)

getMemberAttributesBlock

public static boolean getMemberAttributesBlock(EssSession session,
                                               Identifier identifier,
                                               MemberRequestItem[] theRequests,
                                               java.util.Collection c,
                                               java.util.Collection errors)

getMemberFormulaBlock

public static boolean getMemberFormulaBlock(EssSession session,
                                            Identifier identifier,
                                            MemberRequestItem[] theRequests,
                                            java.util.Collection c,
                                            java.util.Collection errors)

findRequest

public static boolean findRequest(EssSession session,
                                  FindRequest request,
                                  Identifier identifier,
                                  java.util.Collection c,
                                  java.util.Collection errors)

findRequestFile

public static boolean findRequestFile(EssSession session,
                                      FindRequest request,
                                      Identifier identifier,
                                      java.lang.String dataPath,
                                      java.lang.String indexPath,
                                      java.util.Collection errors)

getMemberAncestors

public static boolean getMemberAncestors(EssSession session,
                                         java.lang.String memberName,
                                         java.util.Collection c,
                                         java.util.Collection errors)

getMemberAncestorsEx

public static boolean getMemberAncestorsEx(EssSession session,
                                           java.lang.String memberName,
                                           java.util.Collection c,
                                           java.util.Collection errors)

initializeViewer

public static boolean initializeViewer(EssSession session,
                                       Identifier identifier,
                                       java.util.List dimensions,
                                       java.util.List dts,
                                       AttributeSpecs specs,
                                       Settings settings,
                                       java.util.Collection errors)

getOutlineInfo

public static int getOutlineInfo(OutlineHandle outlineHandle,
                                 OutlineInfo info)

getServerDateFormats

public static int getServerDateFormats(EssSession session,
                                       java.util.ArrayList dateFormats,
                                       java.util.ArrayList dateStrings)

getVaryingAttributeIndependentDimensionsQuery

public static boolean getVaryingAttributeIndependentDimensionsQuery(EssSession session,
                                                                    java.lang.String attr,
                                                                    java.util.Collection indepMemHandle,
                                                                    java.util.Collection errors)

getVaryingMemberAttributesQuery

public static boolean getVaryingMemberAttributesQuery(EssSession session,
                                                      java.lang.String baseMember,
                                                      java.lang.String baseDimension,
                                                      java.lang.String attrDim,
                                                      java.util.ArrayList perspectiveList,
                                                      boolean needValiditySet,
                                                      java.util.Collection indepDimNames,
                                                      java.util.Collection errors)

getSmartlistFromMemberName

public static boolean getSmartlistFromMemberName(EssSession session,
                                                 java.lang.String memberName,
                                                 java.util.ArrayList list,
                                                 java.util.Collection errors)

getSmartlist

public static boolean getSmartlist(EssSession session,
                                   long memberHandle,
                                   java.util.ArrayList list,
                                   java.util.ArrayList mappingList,
                                   java.util.Collection errors)

getMemberTypeQuery

public static boolean getMemberTypeQuery(EssSession session,
                                         java.lang.String memberName,
                                         MemberType type,
                                         java.util.Collection errors)

getAllSmartlistsQuery

public static boolean getAllSmartlistsQuery(EssSession session,
                                            java.util.ArrayList list,
                                            java.util.ArrayList mappingList,
                                            java.util.Collection errors)

getChildMemberIndex

public static int getChildMemberIndex(EssSession session,
                                      java.lang.String dimension,
                                      java.lang.String parentName,
                                      java.lang.String member,
                                      int startSearchIndex,
                                      int endSearchIndex)

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.