|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OlapConnection
Connection to an OLAP server.
Field Summary |
---|
Fields inherited from interface java.sql.Connection |
---|
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE |
Method Summary | |
---|---|
Scenario |
createScenario()
Creates a Scenario. |
OlapStatement |
createStatement()
|
NamedList<Catalog> |
getCatalogs()
Returns a list of Catalog objects which
belong to this connection's OLAP server. |
java.util.Locale |
getLocale()
Returns this connection's locale. |
OlapDatabaseMetaData |
getMetaData()
|
MdxParserFactory |
getParserFactory()
Returns the factory used to create MDX parsers in this connection. |
java.lang.String |
getRoleName()
Returns the name of the role in which this connection executes queries. |
Scenario |
getScenario()
Returns this connection's active Scenario, or null if there is no active Scenario. |
Schema |
getSchema()
Returns the current Schema of this
connection. |
PreparedOlapStatement |
prepareOlapStatement(java.lang.String mdx)
Creates a prepared OLAP Statement. |
void |
setLocale(java.util.Locale locale)
Sets the current locale of this connection. |
void |
setRoleName(java.lang.String roleName)
Sets the name of the role in which this connection executes queries. |
void |
setScenario(Scenario scenario)
Sets the active Scenario of this connection. |
Methods inherited from interface java.sql.Connection |
---|
clearWarnings, close, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setReadOnly, setSavepoint, setSavepoint, setTransactionIsolation, setTypeMap |
Methods inherited from interface java.sql.Wrapper |
---|
isWrapperFor, unwrap |
Methods inherited from interface org.olap4j.OlapWrapper |
---|
isWrapperFor, unwrap |
Method Detail |
---|
OlapDatabaseMetaData getMetaData() throws OlapException
getMetaData
in interface java.sql.Connection
OlapException
- if database error occursPreparedOlapStatement prepareOlapStatement(java.lang.String mdx) throws OlapException
This method is the equivalent, for OLAP, of the
Connection.prepareStatement(String)
JDBC method.
mdx
- MDX query string
OlapException
- if database error occursMdxParserFactory getParserFactory()
OlapStatement createStatement() throws OlapException
createStatement
in interface java.sql.Connection
OlapException
- if database error occursSchema getSchema() throws OlapException
Schema
of this
connection.
OlapException
- if database error occursNamedList<Catalog> getCatalogs()
Catalog
objects which
belong to this connection's OLAP server.
The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
DatabaseMetaData.getCatalogs()
void setLocale(java.util.Locale locale)
If the locale is not set, the JDK's current locale is used (see
Locale.getDefault()
).
Most drivers support a Locale
connect-string property.
locale
- Localejava.util.Locale getLocale()
void setRoleName(java.lang.String roleName) throws OlapException
roleName
- Name of role
OlapException
- if role name is invalidjava.lang.String getRoleName()
Scenario createScenario()
It does not become the active scenario for the current connection.
To do this, call setScenario(Scenario)
.
setScenario(org.olap4j.Scenario)
void setScenario(Scenario scenario)
After setting a scenario, the client may call
Cell.setValue(java.lang.Object, org.olap4j.AllocationPolicy, java.lang.Object...)
to change the value of cells returned
from queries. The value of those cells is changed. This operation is
referred to as 'writeback', and is used to perform 'what if' analysis,
such as budgeting. See Scenario
for more details.
If scenario
is null, the connection will have no active
scenario, and writeback is not allowed.
Scenarios are created using createScenario()
.
scenario
- ScenarioScenario getScenario()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |