Package org.olap4j.metadata
Interface Database
public interface Database
Highest level element in the hierarchy of metadata objects.
A Database contains one or more Catalog
s.
To obtain the collection of databases in the current server, call the
OlapConnection.getOlapDatabases()
method. To obtain the current
active catalog object, to which a connection is bound, use
OlapConnection.getOlapDatabase()
.
The hierarchy of metadata objects, rooted at the connection from which they are accessed, is as follows:
- Since:
- Jan 15 2011
- Author:
- Luc Boudreau
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
Describes the supported authentication modes.static enum
Describes the possible provider types. -
Method Summary
Modifier and TypeMethodDescriptionReturns the authentication modes supported by this server.Returns a list ofCatalog
objects which belong to this Database.Returns provider-specific information.Returns a human-readable description of this Database.getName()
Returns the unique name of this Database.Retrieves the parentOlapConnection
of this Database object.Returns the name of the underlying OLAP provider.Returns the types of data that are supported by this provider.getURL()
Returns a redirection URL.
-
Method Details
-
getOlapConnection
OlapConnection getOlapConnection()Retrieves the parentOlapConnection
of this Database object.- Returns:
- The parent conenction object.
-
getName
Returns the unique name of this Database.- Returns:
- The database name.
- Throws:
OlapException
- if error occurs.
-
getDescription
Returns a human-readable description of this Database.- Returns:
- The database description. Can be
null
. - Throws:
OlapException
- if error occurs.
-
getURL
Returns a redirection URL. This value is used only in distributed architectures. An OLAP server can serve as a frontal distribution server and redirect clients to delegate servers.Implementations are free to implement a distributed system. Most implementations don't make any use of it and will return the same URL which was used to connect in the first place.
- Returns:
- The database URL. Can be
null
. - Throws:
OlapException
- if error occurs.
-
getDataSourceInfo
Returns provider-specific information.- Returns:
- A string containing provider-specific information.
- Throws:
OlapException
- if error cccurs
-
getProviderName
Returns the name of the underlying OLAP provider.This usually is the server vendor name, for example "Mondrian" or "MSOLAP".
- Returns:
- The provider name.
- Throws:
OlapException
- if error occurs.
-
getProviderTypes
Returns the types of data that are supported by this provider.- Returns:
- The provider types.
- Throws:
OlapException
- if error occurs.
-
getAuthenticationModes
Returns the authentication modes supported by this server.- Returns:
- The authentication mode supported.
- Throws:
OlapException
- if error occurs.
-
getCatalogs
Returns a list ofCatalog
objects which belong to this Database.The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
- Returns:
- List of Catalog in this
Database
- Throws:
OlapException
- if error occurs- See Also:
-