|
SAP BI Java SDK | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The OLAP object finder supports the search for OLAP schema objects.
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 |
public List findCube(Schema schema, String cubeName) throws BIResourceException
null
places no restrictions on the schema.schema
- schema objectcubeName
- cube nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of cubes (null is valid)public Cube findCubeFirst(Schema schema, String cubeName) throws BIResourceException
null
places no restrictions on the schema.schema
- schema objectcubeName
- cube nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid cube (null is valid)public List findDimension(Cube cube, String dimensionName) throws BIResourceException
cube
- cube objectdimensionName
- dimension nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of dimensions
(null is valid)public Dimension findDimensionFirst(Cube cube, String dimensionName) throws BIResourceException
cube
- cube objectdimensionName
- name of the dimension to findBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid dimension (null is valid)public List findHierarchy(Dimension dimension, String hierarchyName) throws BIResourceException
dimension
- dimension objecthierarchyName
- hierarchy nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of level-based hierarchies
(null is valid)public LevelBasedHierarchy findHierarchyFirst(Dimension dimension, String hierarchyName) throws BIResourceException
dimension
- dimension objecthierarchyName
- hierarchy nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid level-based hierarchy
(null is valid)public List findLevel(LevelBasedHierarchy hierarchy, String levelName) throws BIResourceException
hierarchy
- hierarchy object to which the levels belonglevelName
- level nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of levels (null is valid)public Level findLevelFirst(LevelBasedHierarchy hierarchy, String levelName) throws BIResourceException
hierarchy
- hierarchy object the levels belongslevelName
- level nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid level (null is valid)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
schemaName
- name of schema to which member belongscubeName
- name of cube to which members belong; null for all cubes
under a certain schema restrictiondimensionName
- name of dimension; null for all
dimensions under restrictions of schema and cubehierarchyName
- name of hierarchy; null for all
hierarchies under other restrictionslevelName
- level name, null for allmemberName
- member nametreeOperator
- which operation to takeIBIMember
BIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of members (null is valid)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
schemaName
- name of schema to which member belongscubeName
- name of cube to which members belong; null for all cubes
under a certain schema restrictiondimensionName
- name of dimension; null for all
dimensions under restrictions of schema and cubehierarchyName
- name of hierarchy; null for all
hierarchies under other restrictionslevelName
- level name, null for allmemberName
- member nametreeOperator
- which operation to takeIBIMember
BIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of members (null is valid)public List findMember(Level level, String memberName, com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator) throws BIResourceException
level
- level objectmemberName
- member nametreeOperator
- tree operatorBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of members (null is valid)public IBIMember findMemberFirst(Level level, String memberName, com.sap.ip.bi.sdk.dac.connector.olap.BITreeOperator treeOperator) throws BIResourceException
IBIMember
from a level.level
- level object this member belongsmemberName
- member nametreeOperator
- tree operatorIBIMember
BIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid member (null is valid)public List findMeasure(Cube cube, String measureName) throws BIResourceException
cube
- cube objectmeasureName
- measure nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of measures (null is valid)public Measure findMeasureFirst(Cube cube, String measureName) throws BIResourceException
cube
- cube to which the measure belongsmeasureName
- measure nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid measure (null is valid)public List findSchema(String schemaName) throws BIResourceException
schemaName
- name of schemaBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of schemas (null is valid)public Schema findSchemaFirst(String schemaName) throws BIResourceException
schemaName
- name of schemaBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid schemas (null is valid)public List findCube(String schemaName, String cubeName) throws BIResourceException
schemaName
- name of schema to which cubes belong;
null means no restrictionscubeName
- name of cube; null means all cubes under a certain schemaBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of cubes (null is valid)public Cube findCubeFirst(String schemaName, String cubeName) throws BIResourceException
schemaName
- name of schema to which cubes belong;
null means no restrictionscubeName
- name of cube; null means all cubes under a certain schemaBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid cube (null is valid)public List findDimension(String schemaName, String cubeName, String dimensionName) throws BIResourceException
schemaName
- name of schema to which the dimension belongscubeName
- name of cube to which the dimensions belong; null for all cubes
under a certain schema restrictiondimensionName
- name of dimensionBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of dimensions
(null is valid)public Dimension findDimensionFirst(String schemaName, String cubeName, String dimensionName) throws BIResourceException
schemaName
- name of schema to which the dimension belongscubeName
- name of cube to which the dimensions belong; null for all cubes
under a certain schema restrictiondimensionName
- name of dimensionBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid dimension
(null is valid)public List findHierarchy(String schemaName, String cubeName, String dimensionName, String hierarchyName) throws BIResourceException
schemaName
- name of schema to which hierarchy belongscubeName
- name of cube to which hierarchies belong; null for all cubes
under a certain schema restrictiondimensionName
- unique name of dimension; null for all
dimensions under restrictions of schema and cubehierarchyName
- name of hierarchyBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of hierarchies
(null is valid)public LevelBasedHierarchy findHierarchyFirst(String schemaName, String cubeName, String dimensionName, String hierarchyName) throws BIResourceException
schemaName
- name of schema to which hierarchy belongscubeName
- name of cube to which hierarchies belong; null for all cubes
under a certain schema restrictiondimensionName
- unique name of dimension; null for all
dimensions under restrictions of schema and cubehierarchyName
- name of hierarchyBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid level-based hierarchy
(null is valid)public List findLevel(String schemaName, String cubeName, String dimensionName, String hierarchyName, String levelName) throws BIResourceException
schemaName
- name of schema to which level belongscubeName
- name of cube to which levels belong; null for all cubes
under a certain schema restrictiondimensionName
- name of dimension; null for all
dimensions under restrictions of schema and cubehierarchyName
- name of hierarchy; null for all
hierarchies under other restrictionslevelName
- level nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of levels (null is valid)public Level findLevelFirst(String schemaName, String cubeName, String dimensionName, String hierarchyName, String levelName) throws BIResourceException
schemaName
- name of schema to which level belongscubeName
- name of cube to which levels belong; null for all cubes
under a certain schema restrictiondimensionName
- name of dimension; null for all
dimensions under restrictions of schema and cubehierarchyName
- name of hierarchy; null for all
hierarchies under other restrictionslevelName
- level nameBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid level (null is valid)public List findMeasure(String schemaName, String cubeName, String measureName) throws BIResourceException
schemaName
- schemaName name of schema to which measure belongscubeName
- name of cube to which measures belong; null
for all cubes under a certain schema restrictionmeasureName
- name of measureBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of measures (null is valid)public Measure findMeasureFirst(String schemaName, String cubeName, String measureName) throws BIResourceException
schemaName
- schemaName name of schema to which measure belongscubeName
- name of cube to which measures belong; null
for all cubes under a certain schema restrictionmeasureName
- name of measureBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a measure (null is valid)public IBIResultSet findMemberData(List restrictions, List selectedAttributes) throws BIResourceException
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.restrictions
- a list of Common Warehouse Metamodel (CWM) metadata objects:
schema
cube
dimension
level
member
treeOperator
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.IBIResultSet
BIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid
IBIResultSet
implementation (null is valid)public List findSAPVariable(String schemaName, String cubeName, String variableName) throws BIResourceException
SAP variables
.schemaName
- name of schema to which SAP variable belongscubeName
- name of cube to which SAP variables belong; null for all
cubes under a certain schema restrictionvariableName
- name of SAP variableBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of
SAP variable
implementations (null is valid)public IBISapVariable findSAPVariableFirst(String schemaName, String cubeName, String variableName) throws BIResourceException
SAP variable
from a list of SAP variables according to specified restrictions.schemaName
- name of schema to which SAP variable belongscubeName
- name of cube to which SAP variables belong; null for all
cubes under a certain schema restrictionvariableName
- name of SAP variableBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid
SAP variable
implementation (null is valid)public List findSAPVariable(Cube cube, String variableName) throws BIResourceException
SAP variables
according to specified restrictions.cube
- cube objectvariableName
- name of SAP variableBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid list of
SAP variable
implementations (null is valid)public IBISapVariable findSAPVariableFirst(Cube cube, String variableName) throws BIResourceException
SAP variable
from a list of SAP variables according to specified restrictions.cube
- cube objectvariableName
- name of SAP variableBIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid
SAP variable
implementation (null is valid)
|
SAP BI Java SDK | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |