|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OlapDatabaseMetaData
Information about an OLAP database.
Methods are provided to query the metadata catalog of the database.
There is a method for each metadata class, and each method takes zero or more
parameters to qualify the instances should be returned, and returns a JDBC
ResultSet
.
For example, getCubes(java.lang.String, java.lang.String, java.lang.String)
returns the description of a cube.
Field Summary |
---|
Fields inherited from interface java.sql.DatabaseMetaData |
---|
attributeNoNulls, attributeNullable, attributeNullableUnknown, bestRowNotPseudo, bestRowPseudo, bestRowSession, bestRowTemporary, bestRowTransaction, bestRowUnknown, columnNoNulls, columnNullable, columnNullableUnknown, functionColumnIn, functionColumnInOut, functionColumnOut, functionColumnResult, functionColumnUnknown, functionNoNulls, functionNoTable, functionNullable, functionNullableUnknown, functionResultUnknown, functionReturn, functionReturnsTable, importedKeyCascade, importedKeyInitiallyDeferred, importedKeyInitiallyImmediate, importedKeyNoAction, importedKeyNotDeferrable, importedKeyRestrict, importedKeySetDefault, importedKeySetNull, procedureColumnIn, procedureColumnInOut, procedureColumnOut, procedureColumnResult, procedureColumnReturn, procedureColumnUnknown, procedureNoNulls, procedureNoResult, procedureNullable, procedureNullableUnknown, procedureResultUnknown, procedureReturnsResult, sqlStateSQL, sqlStateSQL99, sqlStateXOpen, tableIndexClustered, tableIndexHashed, tableIndexOther, tableIndexStatistic, typeNoNulls, typeNullable, typeNullableUnknown, typePredBasic, typePredChar, typePredNone, typeSearchable, versionColumnNotPseudo, versionColumnPseudo, versionColumnUnknown |
Method Summary | |
---|---|
java.sql.ResultSet |
getActions(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String cubeNamePattern,
java.lang.String actionNamePattern)
Retrieves a result set describing the Actions in this database. |
OlapConnection |
getConnection()
|
java.sql.ResultSet |
getCubes(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String cubeNamePattern)
Retrieves a result set describing the Cubes in this database. |
java.sql.ResultSet |
getDatabaseProperties(java.lang.String dataSourceName,
java.lang.String propertyNamePattern)
Retrieves a list of the standard and provider-specific properties supported by an olap4j provider. |
java.sql.ResultSet |
getDatasources()
Retrives a list of olap4j data sources that are available on the server. |
java.sql.ResultSet |
getDimensions(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String cubeNamePattern,
java.lang.String dimensionNamePattern)
Retrieves a result set describing the shared and private Dimensions in this database. |
java.sql.ResultSet |
getHierarchies(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String cubeNamePattern,
java.lang.String dimensionUniqueName,
java.lang.String hierarchyNamePattern)
Retrieves a result set describing the Hierarchies in this database. |
java.sql.ResultSet |
getLevels(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String cubeNamePattern,
java.lang.String dimensionUniqueName,
java.lang.String hierarchyUniqueName,
java.lang.String levelNamePattern)
Retrieves a result set describing the Levels in this database. |
java.sql.ResultSet |
getLiterals()
Retrieves a list of information on supported literals, including data types and values. |
java.lang.String |
getMdxKeywords()
Retrieves a comma-separated list of all of this database's MDX keywords. |
java.sql.ResultSet |
getMeasures(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String cubeNamePattern,
java.lang.String measureNamePattern,
java.lang.String measureUniqueName)
Retrieves a result set describing the Measures in this database. |
java.sql.ResultSet |
getMembers(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String cubeNamePattern,
java.lang.String dimensionUniqueName,
java.lang.String hierarchyUniqueName,
java.lang.String levelUniqueName,
java.lang.String memberUniqueName,
java.util.Set<Member.TreeOp> treeOps)
Retrieves a result set describing the Members in this database. |
java.sql.ResultSet |
getOlapFunctions(java.lang.String functionNamePattern)
Retrieves a result set describing the Functions available to client applications connected to the database. |
java.sql.ResultSet |
getProperties(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String cubeNamePattern,
java.lang.String dimensionUniqueName,
java.lang.String hierarchyUniqueName,
java.lang.String levelUniqueName,
java.lang.String memberUniqueName,
java.lang.String propertyNamePattern)
Retrieves a result set describing member and cell Properties. |
java.sql.ResultSet |
getSets(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String cubeNamePattern,
java.lang.String setNamePattern)
Retrieves a result set describing the named Sets in this database. |
Methods inherited from interface java.sql.DatabaseMetaData |
---|
allProceduresAreCallable, allTablesAreSelectable, autoCommitFailureClosesAllResultSets, dataDefinitionCausesTransactionCommit, dataDefinitionIgnoredInTransactions, deletesAreDetected, doesMaxRowSizeIncludeBlobs, getAttributes, getBestRowIdentifier, getCatalogs, getCatalogSeparator, getCatalogTerm, getClientInfoProperties, getColumnPrivileges, getColumns, getCrossReference, getDatabaseMajorVersion, getDatabaseMinorVersion, getDatabaseProductName, getDatabaseProductVersion, getDefaultTransactionIsolation, getDriverMajorVersion, getDriverMinorVersion, getDriverName, getDriverVersion, getExportedKeys, getExtraNameCharacters, getFunctionColumns, getFunctions, getIdentifierQuoteString, getImportedKeys, getIndexInfo, getJDBCMajorVersion, getJDBCMinorVersion, getMaxBinaryLiteralLength, getMaxCatalogNameLength, getMaxCharLiteralLength, getMaxColumnNameLength, getMaxColumnsInGroupBy, getMaxColumnsInIndex, getMaxColumnsInOrderBy, getMaxColumnsInSelect, getMaxColumnsInTable, getMaxConnections, getMaxCursorNameLength, getMaxIndexLength, getMaxProcedureNameLength, getMaxRowSize, getMaxSchemaNameLength, getMaxStatementLength, getMaxStatements, getMaxTableNameLength, getMaxTablesInSelect, getMaxUserNameLength, getNumericFunctions, getPrimaryKeys, getProcedureColumns, getProcedures, getProcedureTerm, getResultSetHoldability, getRowIdLifetime, getSchemas, getSchemas, getSchemaTerm, getSearchStringEscape, getSQLKeywords, getSQLStateType, getStringFunctions, getSuperTables, getSuperTypes, getSystemFunctions, getTablePrivileges, getTables, getTableTypes, getTimeDateFunctions, getTypeInfo, getUDTs, getURL, getUserName, getVersionColumns, insertsAreDetected, isCatalogAtStart, isReadOnly, locatorsUpdateCopy, nullPlusNonNullIsNull, nullsAreSortedAtEnd, nullsAreSortedAtStart, nullsAreSortedHigh, nullsAreSortedLow, othersDeletesAreVisible, othersInsertsAreVisible, othersUpdatesAreVisible, ownDeletesAreVisible, ownInsertsAreVisible, ownUpdatesAreVisible, storesLowerCaseIdentifiers, storesLowerCaseQuotedIdentifiers, storesMixedCaseIdentifiers, storesMixedCaseQuotedIdentifiers, storesUpperCaseIdentifiers, storesUpperCaseQuotedIdentifiers, supportsAlterTableWithAddColumn, supportsAlterTableWithDropColumn, supportsANSI92EntryLevelSQL, supportsANSI92FullSQL, supportsANSI92IntermediateSQL, supportsBatchUpdates, supportsCatalogsInDataManipulation, supportsCatalogsInIndexDefinitions, supportsCatalogsInPrivilegeDefinitions, supportsCatalogsInProcedureCalls, supportsCatalogsInTableDefinitions, supportsColumnAliasing, supportsConvert, supportsConvert, supportsCoreSQLGrammar, supportsCorrelatedSubqueries, supportsDataDefinitionAndDataManipulationTransactions, supportsDataManipulationTransactionsOnly, supportsDifferentTableCorrelationNames, supportsExpressionsInOrderBy, supportsExtendedSQLGrammar, supportsFullOuterJoins, supportsGetGeneratedKeys, supportsGroupBy, supportsGroupByBeyondSelect, supportsGroupByUnrelated, supportsIntegrityEnhancementFacility, supportsLikeEscapeClause, supportsLimitedOuterJoins, supportsMinimumSQLGrammar, supportsMixedCaseIdentifiers, supportsMixedCaseQuotedIdentifiers, supportsMultipleOpenResults, supportsMultipleResultSets, supportsMultipleTransactions, supportsNamedParameters, supportsNonNullableColumns, supportsOpenCursorsAcrossCommit, supportsOpenCursorsAcrossRollback, supportsOpenStatementsAcrossCommit, supportsOpenStatementsAcrossRollback, supportsOrderByUnrelated, supportsOuterJoins, supportsPositionedDelete, supportsPositionedUpdate, supportsResultSetConcurrency, supportsResultSetHoldability, supportsResultSetType, supportsSavepoints, supportsSchemasInDataManipulation, supportsSchemasInIndexDefinitions, supportsSchemasInPrivilegeDefinitions, supportsSchemasInProcedureCalls, supportsSchemasInTableDefinitions, supportsSelectForUpdate, supportsStatementPooling, supportsStoredFunctionsUsingCallSyntax, supportsStoredProcedures, supportsSubqueriesInComparisons, supportsSubqueriesInExists, supportsSubqueriesInIns, supportsSubqueriesInQuantifieds, supportsTableCorrelationNames, supportsTransactionIsolationLevel, supportsTransactions, supportsUnion, supportsUnionAll, updatesAreDetected, usesLocalFilePerTable, usesLocalFiles |
Methods inherited from interface java.sql.Wrapper |
---|
isWrapperFor, unwrap |
Methods inherited from interface org.olap4j.OlapWrapper |
---|
isWrapperFor, unwrap |
Method Detail |
---|
OlapConnection getConnection() throws java.sql.SQLException
getConnection
in interface java.sql.DatabaseMetaData
java.sql.SQLException
java.sql.ResultSet getActions(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String actionNamePattern) throws OlapException
Specification as for XML/A MDSCHEMA_ACTIONS schema rowset.
Each action description has the following columns:
null
) => The name of
the database.null
) => The name of
the schema to which this action belongs.
catalog
- a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used
to narrow the searchschemaPattern
- a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a
schema; null
means that the schema name should not
be used to narrow the searchcubeNamePattern
- a cube name pattern; must match the
cube name as it is stored in the database; "" retrieves those
without a cube (such as shared dimensions);
null
means that the cube name should
not be used to narrow the searchactionNamePattern
- an action name pattern; must match the
action name as it is stored in the database; null
means that the action name should not be used to narrow the
search
ResultSet
object in which each row is an
action description
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
java.sql.ResultSet getDatasources() throws OlapException
Specification as for XML/A DISCOVER_DATASOURCES schema rowset.
null
)null
)null
)null
)
ResultSet
object in which each row is a
datasource description
OlapException
- if a database access error occursjava.sql.ResultSet getLiterals() throws OlapException
Specification as for XML/A DISCOVER_LITERALS schema rowset.
null
) => Contains
the actual literal value.null
) =>
The characters, in the literal, that are not valid.null
) => The characters that are not valid as the
first character of the literal. If the literal can start with
any valid character, this is null.null
) => The
maximum number of characters in the literal. If there is no
maximum or the maximum is unknown, the value is -1.
ResultSet
object in which each row is a
literal description
OlapException
- if a database access error occursjava.sql.ResultSet getDatabaseProperties(java.lang.String dataSourceName, java.lang.String propertyNamePattern) throws OlapException
Specification as for XML/A DISCOVER_PROPERTIES schema rowset.
Not to be confused with getProperties(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
.
dataSourceName
- Name of data sourcepropertyNamePattern
- an property name pattern; must match the
property name as it is stored in the database; null
means that the property name should not be used to narrow the
search
ResultSet
object in which each row is a
the description of a database property
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
java.sql.ResultSet getProperties(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionUniqueName, java.lang.String hierarchyUniqueName, java.lang.String levelUniqueName, java.lang.String memberUniqueName, java.lang.String propertyNamePattern) throws OlapException
Specification as for XML/A MDSCHEMA_PROPERTIES schema rowset.
Not to be confused with getDatabaseProperties(String,String)
.
null
) => The name of
the database.null
) => The name of
the schema to which this property belongs.null
) => The
unique name of the member to which the property belongs.null
) => The
type of the property. null
) => A
human-readable description of the measure.
catalog
- a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used
to narrow the searchschemaPattern
- a schema name pattern; must match the schema
name as it is stored in the database; "" retrieves those without
a schema; null
means that the schema name should not
be used to narrow the searchcubeNamePattern
- a cube name pattern; must match the
cube name as it is stored in the database; "" retrieves those
without a cube; null
means that the cube name should
not be used to narrow the searchdimensionUniqueName
- unique name of a dimension (not a pattern);
must match the dimension name as it is stored in the database;
null
means that the dimension name should not be
used to narrow the searchhierarchyUniqueName
- unique name of a hierarchy (not a pattern);
must match the
hierarchy name as it is stored in the database; null
means that the hierarchy name should not be used to narrow the
searchlevelUniqueName
- unique name of a level (not a pattern);
must match the
level name as it is stored in the database; null
means that the level name should not be used to narrow the
searchmemberUniqueName
- unique name of member (not a pattern);
null
means that the member unique name should not be used to narrow
the searchpropertyNamePattern
- a property name pattern; must match the
property name as it is stored in the database; null
means that the property name should not be used to narrow the
search
ResultSet
object in which each row is a
description of a member or cell property
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
,
Property
java.lang.String getMdxKeywords() throws OlapException
OlapException
- if a database access error occursjava.sql.ResultSet getCubes(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern) throws OlapException
Specification as for XML/A MDSCHEMA_CUBES schema rowset.
Each cube description has the following columns:
null
) => The name of
the catalog to which this cube belongs.null
) => The name of
the schema to which this cube belongs.null
) => Cube type.null
) => Date and
time of cube creation.null
) =>
Date and time of last schema update.null
) => User
ID of the person who last updated the schema.null
) => Date
and time of last data update.null
) => User ID
of the person who last updated the data. null
) => A
user-friendly description of the dimension.
catalog
- a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used
to narrow the searchschemaPattern
- a schema name pattern; must match the schema
name as it is stored in the database; "" retrieves those without
a schema; null
means that the schema name should not
be used to narrow the searchcubeNamePattern
- a cube name pattern; must match the
cube name as it is stored in the database; null
means that the cube name should not be used to narrow the search
ResultSet
in which each row is a cube description
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
,
Cube
java.sql.ResultSet getDimensions(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionNamePattern) throws OlapException
Specification as for XML/A MDSCHEMA_DIMENSIONS schema rowset.
Each dimension description has the following columns:
null
) => The name of
the database.null
) => Not
supported.null
) => Not
supported.null
) => A
user-friendly description of the dimension.null
) => Always
FALSE.null
) => A Boolean
that indicates whether the dimension is write-enabled.null
) => A
bitmap that specifies which columns contain unique values if
the dimension contains only members with unique names.null
) => Always NULL.null
) =>
Always TRUE.
catalog
- a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used
to narrow the searchschemaPattern
- a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a
schema; null
means that the schema name should not
be used to narrow the searchcubeNamePattern
- a cube name pattern; must match the
cube name as it is stored in the database; "" retrieves those
without a cube (such as shared dimensions);
null
means that the cube name should
not be used to narrow the searchdimensionNamePattern
- a dimension name pattern; must match the
dimension name as it is stored in the database; null
means that the dimension name should not be used to narrow the
search
ResultSet
object in which each row is a
dimension description
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
,
Dimension
java.sql.ResultSet getOlapFunctions(java.lang.String functionNamePattern) throws OlapException
Specification as for XML/A MDSCHEMA_FUNCTIONS schema rowset.
Each function description has the following columns:
null
) => A
description of the function.null
) => A comma
delimited list of parameters.null
) => The name of
the type library for user-defined functions. NULL for MDX
functions.null
) => The display
caption for the function.
functionNamePattern
- a function name pattern; must match the
function name as it is stored in the database; null
means that the function name should not be used to narrow the
search
ResultSet
object in which each row is a
function description
OlapException
- if a database access error occursDatabaseMetaData.getFunctions(String, String, String)
,
DatabaseMetaData.getSearchStringEscape()
java.sql.ResultSet getHierarchies(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionUniqueName, java.lang.String hierarchyNamePattern) throws OlapException
Specification as for XML/A MDSCHEMA_HIERARCHIES schema rowset.
Each hierarchy description has the following columns:
null
) => The name of
the catalog to which this hierarchy belongs.null
) => Not
supportednull
) => Hierarchy
GUID.null
) => The
default member for this hierarchy. null
) => The member at
the highest level of rollup in the hierarchy.null
) => A
human-readable description of the hierarchy. NULL if no
description exists.null
) => Is
hierarchy a parent.
catalog
- a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used
to narrow the searchschemaPattern
- a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a
schema; null
means that the schema name should not
be used to narrow the searchcubeNamePattern
- a cube name pattern; must match the
cube name as it is stored in the database; "" retrieves those
without a cube; null
means that the cube name should
not be used to narrow the searchdimensionUniqueName
- unique name of a dimension (not a pattern);
must match the
dimension name as it is stored in the database; null
means that the dimension name should not be used to narrow the
searchhierarchyNamePattern
- a hierarchy name pattern; must match the
hierarchy name as it is stored in the database; null
means that the hierarchy name should not be used to narrow the
search
ResultSet
object in which each row is a
hierarchy description
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
,
Hierarchy
java.sql.ResultSet getLevels(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionUniqueName, java.lang.String hierarchyUniqueName, java.lang.String levelNamePattern) throws OlapException
Specification as for XML/A MDSCHEMA_LEVELS schema rowset.
Each level description has the following columns:
null
) => The name of
the catalog to which this level belongs.null
) => The name of
the schema to which this level belongs.null
) => Level
GUID.null
) => A
human-readable description of the level. NULL if no
description exists.
catalog
- a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used
to narrow the searchschemaPattern
- a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a
schema; null
means that the schema name should not
be used to narrow the searchcubeNamePattern
- a cube name pattern; must match the
cube name as it is stored in the database; "" retrieves those
without a cube; null
means that the cube name should
not be used to narrow the searchdimensionUniqueName
- unique name of a dimension (not a pattern);
must match the
dimension name as it is stored in the database; null
means that the dimension name should not be used to narrow the
searchhierarchyUniqueName
- unique name of a hierarchy (not a pattern);
must match the
hierarchy name as it is stored in the database; null
means that the hierarchy name should not be used to narrow the
searchlevelNamePattern
- a level name pattern; must match the
level name as it is stored in the database; null
means that the level name should not be used to narrow the
search
ResultSet
object in which each row is a
level description
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
,
Level
java.sql.ResultSet getMeasures(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String measureNamePattern, java.lang.String measureUniqueName) throws OlapException
Specification as for XML/A MDSCHEMA_MEASURES schema rowset.
Each measure description has the following columns:
null
) => The name of
the catalog to which this measure belongs. null
) => The name of
the schema to which this measure belongs.null
) => Measure
GUID.null
) => A string
that always returns NULL. EXCEPT that SQL Server returns
non-null values!!!null
) => A
human-readable description of the measure.
catalog
- a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used
to narrow the searchschemaPattern
- a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a
schema; null
means that the schema name should not
be used to narrow the searchcubeNamePattern
- a cube name pattern; must match the
cube name as it is stored in the database; "" retrieves those
without a cube; null
means that the cube name should
not be used to narrow the searchmeasureNamePattern
- a measure name pattern; must match the
measure name as it is stored in the database; null
means that the measure name should not be used to narrow the
searchmeasureUniqueName
- unique name of measure (not a pattern);
null
means that the measure unique name should not
be used to narrow the search
ResultSet
object in which each row is a
measure description
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
,
Measure
java.sql.ResultSet getMembers(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String dimensionUniqueName, java.lang.String hierarchyUniqueName, java.lang.String levelUniqueName, java.lang.String memberUniqueName, java.util.Set<Member.TreeOp> treeOps) throws OlapException
Specification as for XML/A MDSCHEMA_MEMBERS schema rowset. Rows are sorted by level number then by ordinal.
The treeOps
parameter allows you to retrieve members
relative to a given member. It is only applicable if a
memberUniqueName
is also specified; otherwise it is
ignored. The following example retrieves all descendants and ancestors
of California, but not California itself:
OlapDatabaseMetaData metaData; ResultSet rset = metaData.getMembers( "LOCALDB", "FoodMart", "Sales", null, null, null, "[Customers].[USA].[CA]", EnumSet.of(Member.TreeOp.ANCESTORS, Member.TreeOp.DESCENDANTS));
Each member description has the following columns:
null
) => The name of
the catalog to which this member belongs. null
) => The name of
the schema to which this member belongs. null
) => Memeber
GUID.null
) =>
Unique name of the member's parent.null
) => Tree
Operationnull
) => depth
catalog
- a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used
to narrow the searchschemaPattern
- a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a
schema; null
means that the schema name should not
be used to narrow the searchcubeNamePattern
- a cube name pattern; must match the
cube name as it is stored in the database; "" retrieves those
without a cube; null
means that the cube name should
not be used to narrow the searchdimensionUniqueName
- unique name of dimension (not a pattern);
must match the
dimension name as it is stored in the database; null
means that the dimension name should not be used to narrow the
searchhierarchyUniqueName
- unique name of hierarchy (not a pattern);
must match the
hierarchy name as it is stored in the database; null
means that the hierarchy name should not be used to narrow the
searchlevelUniqueName
- unique name of level (not a pattern); must match
the level name as it is stored in the database; null
means that the level name should not be used to narrow the
searchmemberUniqueName
- unique name of member (not a pattern);
null
means that the measure unique name should not
be used to narrow the searchtreeOps
- set of tree operations to retrieve members relative
to the member whose unique name was specified; or null to return
just the member itself.
Ignored if memberUniqueName
is not specified.
ResultSet
object in which each row is a
member description
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
,
Member
java.sql.ResultSet getSets(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String cubeNamePattern, java.lang.String setNamePattern) throws OlapException
Specification as for XML/A MDSCHEMA_SETS schema rowset.
Each set description has the following columns:
null
) => nullnull
) => null
catalog
- a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used
to narrow the searchschemaPattern
- a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a
schema; null
means that the schema name should not
be used to narrow the searchcubeNamePattern
- a cube name pattern; must match the
cube name as it is stored in the database; "" retrieves those
without a cube; null
means that the cube name should
not be used to narrow the searchsetNamePattern
- pattern for the unique name of a set; must match
the set name as it is stored in the database; null
means that the set name should not be used to narrow the
search
ResultSet
object in which each row is a
description of a named set
OlapException
- if a database access error occursDatabaseMetaData.getSearchStringEscape()
,
NamedSet
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |