SAP BI Java SDK

com.sap.ip.bi.sdk.dac.connector
Interface IBIOlapObjectFinder


public interface IBIOlapObjectFinder

The OLAP object finder supports the search for OLAP schema objects.

Since:
3.50

Method Summary
 List findCube(Schema schema, String cubeName)
          Returns a list of cubes from a given schema.
 List findCube(String schemaName, String cubeName)
          Returns a list of cubes according to the parameters given.
 Cube findCubeFirst(Schema schema, String cubeName)
          Returns the first cube from a schema.
 Cube findCubeFirst(String schemaName, String cubeName)
          Returns the first cube from a list of cubes according to the parameters given.
 List findDimension(Cube cube, String dimensionName)
          Returns a list of dimensions under a cube.
 List findDimension(String schemaName, String cubeName, String dimensionName)
          Returns a list of dimensions according to the parameters given.
 Dimension findDimensionFirst(Cube cube, String dimensionName)
          Returns the first dimension under a cube.
 Dimension findDimensionFirst(String schemaName, String cubeName, String dimensionName)
          Returns the first dimension from a list of dimensions according to the parameters given.
 List findHierarchy(Dimension dimension, String hierarchyName)
          Returns a list of level-based hierarchies under a dimension.
 List findHierarchy(String schemaName, String cubeName, String dimensionName, String hierarchyName)
          Returns a list of hierarchies according to the parameters given.
 LevelBasedHierarchy findHierarchyFirst(Dimension dimension, String hierarchyName)
          Returns the first level-based hierarchy under a dimension.
 LevelBasedHierarchy findHierarchyFirst(String schemaName, String cubeName, String dimensionName, String hierarchyName)
          Returns the first level-based hierarchy from a list of hierarchies according to the parameters given.
 List findLevel(LevelBasedHierarchy hierarchy, String levelName)
          Returns a list of levels from a hierarchy.
 List findLevel(String schemaName, String cubeName, String dimensionName, String hierarchyName, String levelName)
          Returns a list of levels according to restrictions given.
 Level findLevelFirst(LevelBasedHierarchy hierarchy, String levelName)
          Returns the first level from a hierarchy.
 Level findLevelFirst(String schemaName, String cubeName, String dimensionName, String hierarchyName, String levelName)
          Returns the first level from a list of levels according to restrictions given.
 List findMeasure(Cube cube, String measureName)
          Returns a list of measures from a cube.
 List findMeasure(String schemaName, String cubeName, String measureName)
          Returns a list of measures according to the restrictions specified.
 Measure findMeasureFirst(Cube cube, String measureName)
          Returns the first measure from a cube.
 Measure findMeasureFirst(String schemaName, String cubeName, String measureName)
          Returns the first measure from a list of measures according to the restrictions specified.
 List findMember(Level level, String memberName, com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator)
          Returns a list of members from a level.
 List findMember(String schemaName, String cubeName, String dimensionName, String hierarchyName, String levelName, String memberName, com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator)
          Returns a list of members according to restrictions.
 IBIResultSet findMemberData(List restrictions, List selectedAttributes)
          Returns the IBIResultSet that contains member-related data information according to the given restrictions, the attributes of which need to be returned according to the list of selected attributes.
 IBIMember findMemberFirst(Level level, String memberName, com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator)
          Returns the first IBIMember from a level.
 IBIMember findMemberFirst(String schemaName, String cubeName, String dimensionName, String hierarchyName, String levelName, String memberName, com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator)
          Returns a list of members according to restrictions.
 List findSAPVariable(Cube cube, String variableName)
          Returns a list of SAP variables according to specified restrictions.
 List findSAPVariable(String schemaName, String cubeName, String variableName)
          Returns a list of SAP variables.
 IBISapVariable findSAPVariableFirst(Cube cube, String variableName)
          Returns the first SAP variable from a list of SAP variables according to specified restrictions.
 IBISapVariable findSAPVariableFirst(String schemaName, String cubeName, String variableName)
          Returns the first SAP variable from a list of SAP variables according to specified restrictions.
 List findSchema(String schemaName)
          Returns a list of schemas according to the parameter given.
 Schema findSchemaFirst(String schemaName)
          Returns the first schema from the list of schemas.
 

Method Detail

findCube

public List findCube(Schema schema,
                     String cubeName)
              throws BIResourceException
Returns a list of cubes from a given schema. Setting to null places no restrictions on the schema.
Parameters:
schema - schema object
cubeName - cube name
Returns:
list of cubes
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of cubes (null is valid)

findCubeFirst

public Cube findCubeFirst(Schema schema,
                          String cubeName)
                   throws BIResourceException
Returns the first cube from a schema. Setting to null places no restrictions on the schema.
Parameters:
schema - schema object
cubeName - cube name
Returns:
first cube
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid cube (null is valid)

findDimension

public List findDimension(Cube cube,
                          String dimensionName)
                   throws BIResourceException
Returns a list of dimensions under a cube.
Parameters:
cube - cube object
dimensionName - dimension name
Returns:
list of dimensions
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of dimensions (null is valid)

findDimensionFirst

public Dimension findDimensionFirst(Cube cube,
                                    String dimensionName)
                             throws BIResourceException
Returns the first dimension under a cube.
Parameters:
cube - cube object
dimensionName - name of the dimension to find
Returns:
first dimension
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid dimension (null is valid)

findHierarchy

public List findHierarchy(Dimension dimension,
                          String hierarchyName)
                   throws BIResourceException
Returns a list of level-based hierarchies under a dimension.
Parameters:
dimension - dimension object
hierarchyName - hierarchy name
Returns:
list of level-based hierarchies
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of level-based hierarchies (null is valid)

findHierarchyFirst

public LevelBasedHierarchy findHierarchyFirst(Dimension dimension,
                                              String hierarchyName)
                                       throws BIResourceException
Returns the first level-based hierarchy under a dimension.
Parameters:
dimension - dimension object
hierarchyName - hierarchy name
Returns:
first level-based hierarchy under a dimension
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid level-based hierarchy (null is valid)

findLevel

public List findLevel(LevelBasedHierarchy hierarchy,
                      String levelName)
               throws BIResourceException
Returns a list of levels from a hierarchy.
Parameters:
hierarchy - hierarchy object to which the levels belong
levelName - level name
Returns:
list of levels
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of levels (null is valid)

findLevelFirst

public Level findLevelFirst(LevelBasedHierarchy hierarchy,
                            String levelName)
                     throws BIResourceException
Returns the first level from a hierarchy.
Parameters:
hierarchy - hierarchy object the levels belongs
levelName - level name
Returns:
first level
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid level (null is valid)

findMember

public List findMember(String schemaName,
                       String cubeName,
                       String dimensionName,
                       String hierarchyName,
                       String levelName,
                       String memberName,
                       com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator)
                throws BIResourceException
Returns a list of members according to restrictions.
Parameters:
schemaName - name of schema to which member belongs
cubeName - name of cube to which members belong; null for all cubes under a certain schema restriction
dimensionName - name of dimension; null for all dimensions under restrictions of schema and cube
hierarchyName - name of hierarchy; null for all hierarchies under other restrictions
levelName - level name, null for all
memberName - member name
treeOperator - which operation to take
Returns:
list of IBIMember
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of members (null is valid)

findMemberFirst

public IBIMember findMemberFirst(String schemaName,
                                 String cubeName,
                                 String dimensionName,
                                 String hierarchyName,
                                 String levelName,
                                 String memberName,
                                 com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator)
                          throws BIResourceException
Returns a list of members according to restrictions.
Parameters:
schemaName - name of schema to which member belongs
cubeName - name of cube to which members belong; null for all cubes under a certain schema restriction
dimensionName - name of dimension; null for all dimensions under restrictions of schema and cube
hierarchyName - name of hierarchy; null for all hierarchies under other restrictions
levelName - level name, null for all
memberName - member name
treeOperator - which operation to take
Returns:
IBIMember
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of members (null is valid)

findMember

public List findMember(Level level,
                       String memberName,
                       com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator)
                throws BIResourceException
Returns a list of members from a level.
Parameters:
level - level object
memberName - member name
treeOperator - tree operator
Returns:
list of members
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of members (null is valid)

findMemberFirst

public IBIMember findMemberFirst(Level level,
                                 String memberName,
                                 com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator)
                          throws BIResourceException
Returns the first IBIMember from a level.
Parameters:
level - level object this member belongs
memberName - member name
treeOperator - tree operator
Returns:
first IBIMember
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid member (null is valid)

findMeasure

public List findMeasure(Cube cube,
                        String measureName)
                 throws BIResourceException
Returns a list of measures from a cube.
Parameters:
cube - cube object
measureName - measure name
Returns:
list of measures
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of measures (null is valid)

findMeasureFirst

public Measure findMeasureFirst(Cube cube,
                                String measureName)
                         throws BIResourceException
Returns the first measure from a cube.
Parameters:
cube - cube to which the measure belongs
measureName - measure name
Returns:
first measure
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid measure (null is valid)

findSchema

public List findSchema(String schemaName)
                throws BIResourceException
Returns a list of schemas according to the parameter given.
Parameters:
schemaName - name of schema
Returns:
list of schema
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of schemas (null is valid)

findSchemaFirst

public Schema findSchemaFirst(String schemaName)
                       throws BIResourceException
Returns the first schema from the list of schemas.
Parameters:
schemaName - name of schema
Returns:
first schema
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid schemas (null is valid)

findCube

public List findCube(String schemaName,
                     String cubeName)
              throws BIResourceException
Returns a list of cubes according to the parameters given. Use each individual parameter as a restriction, because different connectors may have different ways of constructing restrictions. It reduces the overhead of constructing and de-constructing. This applies to all of the find interfaces.
Parameters:
schemaName - name of schema to which cubes belong; null means no restrictions
cubeName - name of cube; null means all cubes under a certain schema
Returns:
list of cubes
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of cubes (null is valid)

findCubeFirst

public Cube findCubeFirst(String schemaName,
                          String cubeName)
                   throws BIResourceException
Returns the first cube from a list of cubes according to the parameters given.
Parameters:
schemaName - name of schema to which cubes belong; null means no restrictions
cubeName - name of cube; null means all cubes under a certain schema
Returns:
first cube
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid cube (null is valid)

findDimension

public List findDimension(String schemaName,
                          String cubeName,
                          String dimensionName)
                   throws BIResourceException
Returns a list of dimensions according to the parameters given.
Parameters:
schemaName - name of schema to which the dimension belongs
cubeName - name of cube to which the dimensions belong; null for all cubes under a certain schema restriction
dimensionName - name of dimension
Returns:
list of dimensions
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of dimensions (null is valid)

findDimensionFirst

public Dimension findDimensionFirst(String schemaName,
                                    String cubeName,
                                    String dimensionName)
                             throws BIResourceException
Returns the first dimension from a list of dimensions according to the parameters given.
Parameters:
schemaName - name of schema to which the dimension belongs
cubeName - name of cube to which the dimensions belong; null for all cubes under a certain schema restriction
dimensionName - name of dimension
Returns:
first dimension
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid dimension (null is valid)

findHierarchy

public List findHierarchy(String schemaName,
                          String cubeName,
                          String dimensionName,
                          String hierarchyName)
                   throws BIResourceException
Returns a list of hierarchies according to the parameters given.
Parameters:
schemaName - name of schema to which hierarchy belongs
cubeName - name of cube to which hierarchies belong; null for all cubes under a certain schema restriction
dimensionName - unique name of dimension; null for all dimensions under restrictions of schema and cube
hierarchyName - name of hierarchy
Returns:
list of hierarchies
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of hierarchies (null is valid)

findHierarchyFirst

public LevelBasedHierarchy findHierarchyFirst(String schemaName,
                                              String cubeName,
                                              String dimensionName,
                                              String hierarchyName)
                                       throws BIResourceException
Returns the first level-based hierarchy from a list of hierarchies according to the parameters given.
Parameters:
schemaName - name of schema to which hierarchy belongs
cubeName - name of cube to which hierarchies belong; null for all cubes under a certain schema restriction
dimensionName - unique name of dimension; null for all dimensions under restrictions of schema and cube
hierarchyName - name of hierarchy
Returns:
first level-based hierarchy
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid level-based hierarchy (null is valid)

findLevel

public List findLevel(String schemaName,
                      String cubeName,
                      String dimensionName,
                      String hierarchyName,
                      String levelName)
               throws BIResourceException
Returns a list of levels according to restrictions given.
Parameters:
schemaName - name of schema to which level belongs
cubeName - name of cube to which levels belong; null for all cubes under a certain schema restriction
dimensionName - name of dimension; null for all dimensions under restrictions of schema and cube
hierarchyName - name of hierarchy; null for all hierarchies under other restrictions
levelName - level name
Returns:
list of levels
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of levels (null is valid)

findLevelFirst

public Level findLevelFirst(String schemaName,
                            String cubeName,
                            String dimensionName,
                            String hierarchyName,
                            String levelName)
                     throws BIResourceException
Returns the first level from a list of levels according to restrictions given.
Parameters:
schemaName - name of schema to which level belongs
cubeName - name of cube to which levels belong; null for all cubes under a certain schema restriction
dimensionName - name of dimension; null for all dimensions under restrictions of schema and cube
hierarchyName - name of hierarchy; null for all hierarchies under other restrictions
levelName - level name
Returns:
first level
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid level (null is valid)

findMeasure

public List findMeasure(String schemaName,
                        String cubeName,
                        String measureName)
                 throws BIResourceException
Returns a list of measures according to the restrictions specified.
Parameters:
schemaName - schemaName name of schema to which measure belongs
cubeName - name of cube to which measures belong; null for all cubes under a certain schema restriction
measureName - name of measure
Returns:
list of measures
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of measures (null is valid)

findMeasureFirst

public Measure findMeasureFirst(String schemaName,
                                String cubeName,
                                String measureName)
                         throws BIResourceException
Returns the first measure from a list of measures according to the restrictions specified.
Parameters:
schemaName - schemaName name of schema to which measure belongs
cubeName - name of cube to which measures belong; null for all cubes under a certain schema restriction
measureName - name of measure
Returns:
first measure
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a measure (null is valid)

findMemberData

public IBIResultSet findMemberData(List restrictions,
                                   List selectedAttributes)
                            throws BIResourceException
Returns the IBIResultSet that contains member-related data information according to the given restrictions, the attributes of which need to be returned according to the list of selected attributes.
Parameters:
restrictions - a list of Common Warehouse Metamodel (CWM) metadata objects:
  • schema
  • cube
  • dimension
  • level
  • member
  • treeOperator
The treeOperator is a special object used to specify that the request selects a particular subset of dimension members based on family relationships.
selectedAttributes - the list of Common Warehouse Metamodel (CWM) attribute objects. If this parameter is null or the list is empty, this interface returns the default set of dimension attributes, which is provider-specific. In the case of the ODBO provider, this will be the column of standard schema rowset.
Returns:
the result set, IBIResultSet
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid IBIResultSet implementation (null is valid)

findSAPVariable

public List findSAPVariable(String schemaName,
                            String cubeName,
                            String variableName)
                     throws BIResourceException
Returns a list of SAP variables.
Parameters:
schemaName - name of schema to which SAP variable belongs
cubeName - name of cube to which SAP variables belong; null for all cubes under a certain schema restriction
variableName - name of SAP variable
Returns:
list of SAP variables
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of SAP variable implementations (null is valid)
Since:
3.50 SP2

findSAPVariableFirst

public IBISapVariable findSAPVariableFirst(String schemaName,
                                           String cubeName,
                                           String variableName)
                                    throws BIResourceException
Returns the first SAP variable from a list of SAP variables according to specified restrictions.
Parameters:
schemaName - name of schema to which SAP variable belongs
cubeName - name of cube to which SAP variables belong; null for all cubes under a certain schema restriction
variableName - name of SAP variable
Returns:
first SAP variable
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid SAP variable implementation (null is valid)
Since:
3.50 SP2

findSAPVariable

public List findSAPVariable(Cube cube,
                            String variableName)
                     throws BIResourceException
Returns a list of SAP variables according to specified restrictions.
Parameters:
cube - cube object
variableName - name of SAP variable
Returns:
list of SAP variables
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of SAP variable implementations (null is valid)
Since:
3.50 SP2

findSAPVariableFirst

public IBISapVariable findSAPVariableFirst(Cube cube,
                                           String variableName)
                                    throws BIResourceException
Returns the first SAP variable from a list of SAP variables according to specified restrictions.
Parameters:
cube - cube object
variableName - name of SAP variable
Returns:
first SAP variable
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid SAP variable implementation (null is valid)
Since:
3.50 SP2

SAP BI Java SDK

Copyright © 2004-2006 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.