Skip navigation links

com.essbase.eas.essbase.server
Class DatabasePrimitives

java.lang.Object
com.essbase.eas.essbase.server.DatabasePrimitives

public final class DatabasePrimitives

extends java.lang.Object

This class provides the primitive operations for an Essbase Database object. In the current implementation, no instances of this class should ever be instantiated.

Version:

1.00, 05/24/2000 1.1.0, 08/04/2000 Upgraded to PW Framework 0.9

Author:

Hank Cox

Method Summary

static boolean	clearDatabase(EssSession session, java.lang.String appName, java.lang.String dbName)
static boolean	clearNonInput(EssSession session, java.lang.String appName, java.lang.String dbName)
static boolean	clearUpperLevel(EssSession session, java.lang.String appName, java.lang.String dbName)
static boolean	copy(ISession session, java.lang.String destApp, java.lang.String destDatabase, java.lang.String srcApp, java.lang.String srcDatabase)
static boolean	copy(ISession session, java.lang.String destApp, java.lang.String destDatabase, java.lang.String srcApp, java.lang.String srcDatabase, boolean replace) copies an database.
static boolean	create(ISession session, java.lang.String appName, java.lang.String newName, boolean currency) creates a database.
static boolean	create(ISession session, java.lang.String appName, java.lang.String newName, boolean currency, boolean unique) creates a database.
static boolean	create(ISession session, java.lang.String appName, java.lang.String newName, boolean currency, boolean unique, boolean replace) creates a database.
static boolean	databaseExists(EssSession session, java.lang.String appName, java.lang.String dbName)
static boolean	delete(ISession session, java.lang.String appName, java.lang.String dbName) deletes a database
static boolean	export(ISession session, java.lang.String appName, java.lang.String DbName, java.lang.String fileName, java.lang.String data, boolean format)
static void	getASOSpecificStatistics(EssSession session, java.lang.String appName, java.lang.String dbName, DatabaseProperties dbProps)
static java.lang.String	getCurrencyDb(EssSession session, java.lang.String appName, java.lang.String dbName)
static boolean	getDatabaseAlias(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.StringBuffer dbAlias)
static boolean	getDatabaseNote(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.StringBuffer dbNote)
static boolean	getDataCalculationState(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.StringBuffer state)
static boolean	getDefaultCalc(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.StringBuffer calcScript)
static java.util.List	getList(EssSession session, java.lang.String application) Creates a list of databases that belong to a specific server.
static java.util.List	getListStatus(EssSession session, java.lang.String appName)
static DatabaseProperties	getProperties(EssSession session, java.lang.String appName, java.lang.String dbName) Retrieves the properties for a set of applications.
static DatabaseProperties	getPropertiesCaches(EssSession session, java.lang.String appName, java.lang.String dbName) Method to get properties only for the Caches tab in the Database Properties dialog
static DatabaseProperties	getPropertiesCurrency(EssSession session, java.lang.String appName, java.lang.String dbName) Method to get properties only for the Currency tab in the Database Properties dialog
static DatabaseProperties	getPropertiesDimensions(EssSession session, java.lang.String appName, java.lang.String dbName) Method to get properties only for the Dimensions tab in the Database Properties dialog
static void	getPropertiesGeneral(DatabaseProperties dbProps, javax.swing.table.TableModel rs)
static DatabaseProperties	getPropertiesGeneral(EssSession session, java.lang.String appName, java.lang.String dbName) Method to get properties only for the General tab in the Database Properties dialog
static DatabaseProperties	getPropertiesModifications(EssSession session, java.lang.String appName, java.lang.String dbName) Method to get properties only for the Modifications tab in the Database Properties dialog
static DatabaseProperties	getPropertiesStatistics(EssSession session, java.lang.String appName, java.lang.String dbName) Method to get properties only for the Statistics tab in the Database Properties dialog
static DatabaseProperties	getPropertiesStorage(EssSession session, java.lang.String appName, java.lang.String dbName)
static DatabaseProperties	getPropertiesStorage(EssSession session, java.lang.String appName, java.lang.String dbName, DatabaseProperties dbProps) Method to get properties only for the Storage tab in the Database Properties dialog
static DatabaseProperties	getPropertiesTransactions(EssSession session, java.lang.String appName, java.lang.String dbName) Method to get properties only for the Transactions tab in the Database Properties dialog
static short	getStatus(EssSession session, java.lang.String appName, java.lang.String dbName)
static java.util.List	getSystemDiskVolumes(EssSession session)
static java.util.List	getUsersGroups(EssSession session, java.lang.String appName, java.lang.String dbName)
static boolean	hasDatabase(ISession session, java.lang.String appName, java.lang.String dbName)
static boolean	isDatabaseLocked(EssSession session, java.lang.String app, java.lang.String db)
static boolean	listDatabaseAliases(EssSession session, java.lang.String appName, java.lang.String dbName, java.util.List dbAliases)
static boolean	rename(ISession session, java.lang.String appName, java.lang.String newName, java.lang.String oldName) renames a database.
static boolean	setActive(EssSession session, java.lang.String appName, java.lang.String dbName)
static boolean	setCurrencyDb(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String currencyDb)
static boolean	setDatabaseAlias(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dbAlias)
static boolean	setDatabaseNote(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dbNote)
static boolean	setDefaultCalc(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String calcScript)
static boolean	setDefaultCalcFile(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String fileName)
static java.util.List	setProperties(ISession session, java.lang.String appName, java.lang.String dbName, boolean storageOnly, DatabaseProperties properties)
static boolean	start(ISession session, java.lang.String appName, java.lang.String dbName) starts an database.
static boolean	stop(ISession session, java.lang.String appName, java.lang.String dbName) stops an database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getList

public static java.util.List getList(EssSession session,
                                     java.lang.String application)

Creates a list of databases that belong to a specific server. Creates the list for a specific application.

Parameters:

session - object for this Essbase session.

application - to restrict request within.

Returns:

a list collection containing strings with the database names.

getListStatus

public static java.util.List getListStatus(EssSession session,
                                           java.lang.String appName)

hasDatabase

public static boolean hasDatabase(ISession session,
                                  java.lang.String appName,
                                  java.lang.String dbName)

copy

public static boolean copy(ISession session,
                           java.lang.String destApp,
                           java.lang.String destDatabase,
                           java.lang.String srcApp,
                           java.lang.String srcDatabase)

copy

public static boolean copy(ISession session,
                           java.lang.String destApp,
                           java.lang.String destDatabase,
                           java.lang.String srcApp,
                           java.lang.String srcDatabase,
                           boolean replace)

copies an database.

Parameters:

session - - session object

destApp - - application name for the copy.

destDatabase - - database name for the copy.

srcApp - - application to be copied.

srcDatabase - = database to be copied.

Returns:

true if the database is successfully copied. What do we do about messages if the call fails?

rename

public static boolean rename(ISession session,
                             java.lang.String appName,
                             java.lang.String newName,
                             java.lang.String oldName)

renames a database.

Parameters:

session - - session object for this command.

appName - - application name that database belongs to.

newName - - new name for this database.

oldName - - old name for this database.

Returns:

true if the rename succeeds. What do we do about messages if the call fails?

export

public static boolean export(ISession session,
                             java.lang.String appName,
                             java.lang.String DbName,
                             java.lang.String fileName,
                             java.lang.String data,
                             boolean format)

create

public static boolean create(ISession session,
                             java.lang.String appName,
                             java.lang.String newName,
                             boolean currency)

creates a database.

Parameters:

session - - session object for this command.

appName - - application to create database in.

newName - - name for the created database.

Returns:

true if the creation succeeds.What do we do about messages if the call fails?

create

public static boolean create(ISession session,
                             java.lang.String appName,
                             java.lang.String newName,
                             boolean currency,
                             boolean unique)

creates a database.

Parameters:

session - - session object for this command.

appName - - application to create database in.

newName - - name for the created database.

currency - - true if currency db

unique - - true if unique db

Returns:

true if the creation succeeds.What do we do about messages if the call fails?

create

public static boolean create(ISession session,
                             java.lang.String appName,
                             java.lang.String newName,
                             boolean currency,
                             boolean unique,
                             boolean replace)

creates a database.

Parameters:

session - - session object for this command.

appName - - application to create database in.

newName - - name for the created database.

currency - - is the db a currencty db

replace - - replace db if it already exists.

Returns:

true if the creation succeeds.What do we do about messages if the call fails?

delete

public static boolean delete(ISession session,
                             java.lang.String appName,
                             java.lang.String dbName)

deletes a database

Parameters:

session - - session object for this command.

appName - - name of application containing the database to be deleted.

dbName - - name of database to delete.

Returns:

true if the delete succeeds. What do we do about messages if the call fails?

start

public static boolean start(ISession session,
                            java.lang.String appName,
                            java.lang.String dbName)

starts an database.

Parameters:

session - - session object for this command.

appName - - name of application to start.

dbName - - name of database to start.

Returns:

true if the database is started. What do we do about messages if the call fails?

stop

public static boolean stop(ISession session,
                           java.lang.String appName,
                           java.lang.String dbName)

stops an database.

Parameters:

session - - session object for this command.

appName - - name of application to stop.

dbName - - name of database to start.

Returns:

true if the database is stopped. What do we do about messages if the call fails?

getASOSpecificStatistics

public static void getASOSpecificStatistics(EssSession session,
                                            java.lang.String appName,
                                            java.lang.String dbName,
                                            DatabaseProperties dbProps)

getProperties

public static DatabaseProperties getProperties(EssSession session,
                                               java.lang.String appName,
                                               java.lang.String dbName)

Retrieves the properties for a set of applications. Instantiates an Application object for each row returned by MaxL.

Parameters:

session - - session object for this command.

appNames - - array of application names.

Returns:

List containing Application objects.

setProperties

public static java.util.List setProperties(ISession session,
                                           java.lang.String appName,
                                           java.lang.String dbName,
                                           boolean storageOnly,
                                           DatabaseProperties properties)

setDefaultCalc

public static boolean setDefaultCalc(EssSession session,
                                     java.lang.String appName,
                                     java.lang.String dbName,
                                     java.lang.String calcScript)

setDefaultCalcFile

public static boolean setDefaultCalcFile(EssSession session,
                                         java.lang.String appName,
                                         java.lang.String dbName,
                                         java.lang.String fileName)

getDefaultCalc

public static boolean getDefaultCalc(EssSession session,
                                     java.lang.String appName,
                                     java.lang.String dbName,
                                     java.lang.StringBuffer calcScript)

setDatabaseNote

public static boolean setDatabaseNote(EssSession session,
                                      java.lang.String appName,
                                      java.lang.String dbName,
                                      java.lang.String dbNote)

getDatabaseNote

public static boolean getDatabaseNote(EssSession session,
                                      java.lang.String appName,
                                      java.lang.String dbName,
                                      java.lang.StringBuffer dbNote)

setDatabaseAlias

public static boolean setDatabaseAlias(EssSession session,
                                       java.lang.String appName,
                                       java.lang.String dbName,
                                       java.lang.String dbAlias)

listDatabaseAliases

public static boolean listDatabaseAliases(EssSession session,
                                          java.lang.String appName,
                                          java.lang.String dbName,
                                          java.util.List dbAliases)

getDatabaseAlias

public static boolean getDatabaseAlias(EssSession session,
                                       java.lang.String appName,
                                       java.lang.String dbName,
                                       java.lang.StringBuffer dbAlias)

clearDatabase

public static boolean clearDatabase(EssSession session,
                                    java.lang.String appName,
                                    java.lang.String dbName)

clearUpperLevel

public static boolean clearUpperLevel(EssSession session,
                                      java.lang.String appName,
                                      java.lang.String dbName)

clearNonInput

public static boolean clearNonInput(EssSession session,
                                    java.lang.String appName,
                                    java.lang.String dbName)

getSystemDiskVolumes

public static java.util.List getSystemDiskVolumes(EssSession session)

getPropertiesGeneral

public static DatabaseProperties getPropertiesGeneral(EssSession session,
                                                      java.lang.String appName,
                                                      java.lang.String dbName)

Method to get properties only for the General tab in the Database Properties dialog

Returns:

a partially populated DatabaseProperties object containing only the information for the General tab in the Database Properties dialog box

getPropertiesGeneral

public static void getPropertiesGeneral(DatabaseProperties dbProps,
                                        javax.swing.table.TableModel rs)

getPropertiesDimensions

public static DatabaseProperties getPropertiesDimensions(EssSession session,
                                                         java.lang.String appName,
                                                         java.lang.String dbName)

Method to get properties only for the Dimensions tab in the Database Properties dialog

Returns:

a partially populated DatabaseProperties object containing only the information for the Dimensions tab in the Database Properties dialog box

getPropertiesStatistics

public static DatabaseProperties getPropertiesStatistics(EssSession session,
                                                         java.lang.String appName,
                                                         java.lang.String dbName)

Method to get properties only for the Statistics tab in the Database Properties dialog

Returns:

a partially populated DatabaseProperties object containing only the information for the Statistics tab in the Database Properties dialog box

getPropertiesCaches

public static DatabaseProperties getPropertiesCaches(EssSession session,
                                                     java.lang.String appName,
                                                     java.lang.String dbName)

Method to get properties only for the Caches tab in the Database Properties dialog

Returns:

a partially populated DatabaseProperties object containing only the information for the Caches tab in the Database Properties dialog box

getPropertiesTransactions

public static DatabaseProperties getPropertiesTransactions(EssSession session,
                                                           java.lang.String appName,
                                                           java.lang.String dbName)

Method to get properties only for the Transactions tab in the Database Properties dialog

Returns:

a partially populated DatabaseProperties object containing only the information for the Transactions tab in the Database Properties dialog box

getPropertiesStorage

public static DatabaseProperties getPropertiesStorage(EssSession session,
                                                      java.lang.String appName,
                                                      java.lang.String dbName)

getPropertiesStorage

public static DatabaseProperties getPropertiesStorage(EssSession session,
                                                      java.lang.String appName,
                                                      java.lang.String dbName,
                                                      DatabaseProperties dbProps)

Method to get properties only for the Storage tab in the Database Properties dialog

Returns:

a partially populated DatabaseProperties object containing only the information for the Storage tab in the Database Properties dialog box

getPropertiesCurrency

public static DatabaseProperties getPropertiesCurrency(EssSession session,
                                                       java.lang.String appName,
                                                       java.lang.String dbName)

Method to get properties only for the Currency tab in the Database Properties dialog

Returns:

a partially populated DatabaseProperties object containing only the information for the Currency tab in the Database Properties dialog box

getPropertiesModifications

public static DatabaseProperties getPropertiesModifications(EssSession session,
                                                            java.lang.String appName,
                                                            java.lang.String dbName)

Method to get properties only for the Modifications tab in the Database Properties dialog

Returns:

a partially populated DatabaseProperties object containing only the information for the Modifications tab in the Database Properties dialog box

getDataCalculationState

public static boolean getDataCalculationState(EssSession session,
                                              java.lang.String appName,
                                              java.lang.String dbName,
                                              java.lang.StringBuffer state)

getCurrencyDb

public static java.lang.String getCurrencyDb(EssSession session,
                                             java.lang.String appName,
                                             java.lang.String dbName)

setCurrencyDb

public static boolean setCurrencyDb(EssSession session,
                                    java.lang.String appName,
                                    java.lang.String dbName,
                                    java.lang.String currencyDb)

setActive

public static boolean setActive(EssSession session,
                                java.lang.String appName,
                                java.lang.String dbName)

getUsersGroups

public static java.util.List getUsersGroups(EssSession session,
                                            java.lang.String appName,
                                            java.lang.String dbName)

databaseExists

public static boolean databaseExists(EssSession session,
                                     java.lang.String appName,
                                     java.lang.String dbName)

isDatabaseLocked

public static boolean isDatabaseLocked(EssSession session,
                                       java.lang.String app,
                                       java.lang.String db)

getStatus

public static short getStatus(EssSession session,
                              java.lang.String appName,
                              java.lang.String dbName)

Skip navigation links