|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
Nested Class Summary | |
---|---|
static class |
Database.AuthenticationMode
Describes the supported authentication modes. |
static class |
Database.ProviderType
Describes the possible provider types. |
Method Summary | |
---|---|
List<Database.AuthenticationMode> |
getAuthenticationModes()
Returns the authentication modes supported by this server. |
NamedList<Catalog> |
getCatalogs()
Returns a list of Catalog objects which belong to
this Database. |
String |
getDataSourceInfo()
Returns provider-specific information. |
String |
getDescription()
Returns a human-readable description of this Database. |
String |
getName()
Returns the unique name of this Database. |
OlapConnection |
getOlapConnection()
Retrieves the parent OlapConnection of this
Database object. |
String |
getProviderName()
Returns the name of the underlying OLAP provider. |
List<Database.ProviderType> |
getProviderTypes()
Returns the types of data that are supported by this provider. |
String |
getURL()
Returns a redirection URL. |
Method Detail |
---|
OlapConnection getOlapConnection()
OlapConnection
of this
Database object.
String getName() throws OlapException
OlapException
- if error occurs.String getDescription() throws OlapException
null
.
OlapException
- if error occurs.String getURL() throws OlapException
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.
null
.
OlapException
- if error occurs.String getDataSourceInfo() throws OlapException
OlapException
- if error cccursString getProviderName() throws OlapException
This usually is the server vendor name, for example "Mondrian" or "MSOLAP".
OlapException
- if error occurs.List<Database.ProviderType> getProviderTypes() throws OlapException
OlapException
- if error occurs.List<Database.AuthenticationMode> getAuthenticationModes() throws OlapException
OlapException
- if error occurs.NamedList<Catalog> getCatalogs() throws OlapException
Catalog
objects which belong to
this Database.
The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
Database
OlapException
- if error occursOlapConnection.getOlapCatalogs()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |