Skip navigation links


com.essbase.eas.essbase.defs
Interface Database

All Known Implementing Classes:
DefaultDatabase, FactoryDatabase

public interface Database

Defines a generic interface for Essbase databases. This interface should be useable in both server and client side databases.

Version:
1.00, 09/13/2000
Author:
Hank Cox
See Also:
DefaultDatabase

Method Summary
 void addAliasTableFileObject(DefaultAliasTableFileObject value)
          adds a excel file object to this application's collection.
 void addCalcScript(DefaultCalcScript value)
          adds a calc script to this database's collection.
 void addDatabaseListener(DatabaseListener l)
          adds a listener for events on an application.
 void addExcelFileObject(DefaultExcelFileObject value)
          adds a excel file object to this application's collection.
 void addFilter(Filter value)
          adds a filter to this database's collection.
 void addFilters(Filter[] values)
           
 void addLotusFileObject(DefaultLotusFileObject value)
          adds a lotus file object to this application's collection.
 void addOutlineFileObject(DefaultOutlineFileObject value)
          adds an outline file object to this application's collection.
 void addPartition(DefaultPartition value)
          adds a partition to this database's collection.
 void addReportScript(DefaultReportScript value)
          adds a report script to this database's collection.
 void addRulesObject(DefaultRulesObject value)
          adds a rules object to this database's collection.
 void addTextFileObject(DefaultTextFileObject value)
          adds a text file object to this application's collection.
 void addVariable(Variable value)
          adds a Variable to this db's collection.
 void decFiltersAccess()
          decrements the filters list user access.
 DefaultPartition existPartition(DefaultPartition part)
          looks up the list of partitions which matches with the source, target and the type info of the partition
 DefaultAliasTableFileObject getAliasTableFileObject(java.lang.String value)
          gets a specific alias table file object from this application's collection.
 DefaultAliasTableFileObject[] getAliasTableFileObjects()
          retrieves this application's collection of excel file objects.
 Application getApplication()
          get the application this database object is contained in.
 DefaultCalcScript getCalcScript(java.lang.String scriptName)
           
 DefaultCalcScript[] getCalcScripts()
          retrieves this database's collection of calc scripts.
 DefaultExcelFileObject getExcelFileObject(java.lang.String value)
           
 DefaultExcelFileObject[] getExcelFileObjects()
          retrieves this application's collection of excel file objects.
 Filter getFilter(java.lang.String filterName)
           
 Filter[] getFilters()
          retrieves this database's collection of filters.
 java.lang.String getFullName()
          returns the full name associated with this database.
 DefaultLotusFileObject getLotusFileObject(java.lang.String value, short version)
           
 DefaultLotusFileObject[] getLotusFileObjects(short version)
          retrieves this application's collection of lotus file objects.
 java.lang.String getName()
          returns the name associated with this database.
 DefaultOutlineFileObject getOutlineFileObject(java.lang.String value)
          gets a specific outline file object from this application's collection.
 DefaultOutlineFileObject[] getOutlineFileObjects()
          retrieves this application's collection of outline file objects.
 DefaultPartition getPartition(java.lang.String srchost, java.lang.String srcIp, java.lang.String srcapp, java.lang.String srcdb, java.lang.String tgthost, java.lang.String tgtIp, java.lang.String tgtapp, java.lang.String tgtdb, int type)
          looks up the partition for which either this is the source and the targer macthes the param or this is the target and the source is the param
 DefaultPartition[] getPartitions()
          retrieves this database's collection of partitions.
 DatabaseProperties getProperties()
          returns properties object associated with this database.
 DatabaseProperties getPropertiesSubset(int propertiesSubset)
           
 DefaultReportScript getReportScript(java.lang.String scriptName)
           
 DefaultReportScript[] getReportScripts()
          retrieves this database's collection of report scripts.
 DefaultRulesObject getRulesObject(java.lang.String scriptName)
           
 DefaultRulesObject[] getRulesObjects()
          retrieves this database's collection of rules objects.
 DefaultPartition getSourcePartition(java.lang.String host, java.lang.String hostIp, java.lang.String app, java.lang.String db, int type)
          looks up the partition list for a partition that is the source partition for this db
 DefaultPartition getTargetPartition(java.lang.String host, java.lang.String hostIp, java.lang.String app, java.lang.String db, int type)
          looks up the partition list for a partition that is the target partition for this db
 DefaultTextFileObject getTextFileObject(java.lang.String value)
           
 DefaultTextFileObject[] getTextFileObjects()
          retrieves this application's collection of text file objects.
 Variable getVariable(java.lang.String name)
          Returns the Variable associated with the name from the collection of variables
 Variable[] getVariables()
          retrieves this db's collection of variables.
 boolean hasTargetPartition()
           
 void incFiltersAccess()
          increments the filters list user access.
 boolean isPropertyLoaded(int property)
           
 boolean isQueryTrackingEnabled()
           
 boolean isStarted()
           
 void partitionUpdated(DefaultPartition value)
          notifies all about the partition getting updated
 void removeAliasTableFileObject(DefaultAliasTableFileObject value)
          removes a excel file object from this application's collection of excel file objects.
 void removeAliasTableFileObject(java.lang.String value)
          removes a excel file object from this server's collection of excel file objects.
 void removeAliasTableFileObjectsNotIn(java.lang.String[] values)
          removes excel file objects from the applications collection that aren't contained in this collection of names.
 void removeAllPartitions()
           
 void removeCalcScript(DefaultCalcScript value)
          removes a calc script from this database's collection of calc scripts.
 void removeCalcScript(java.lang.String value)
          removes a calc script from this database's collection of calc scripts.
 void removeCalcScriptsNotIn(java.lang.String[] values)
          removes calc scripts from the database's collection that aren't contained in this collection of names.
 void removeDatabaseListener(DatabaseListener l)
          removes an event listener from an application
 void removeExcelFileObject(DefaultExcelFileObject value)
          removes a excel file object from this application's collection of excel file objects.
 void removeExcelFileObject(java.lang.String value)
          removes a excel file object from this server's collection of excel file objects.
 void removeExcelFileObjectsNotIn(java.lang.String[] values)
          removes excel file objects from the applications collection that aren't contained in this collection of names.
 void removeFilter(Filter value)
          removes a filter from this database's collection of filters.
 void removeFilter(java.lang.String value)
          removes a filter from this database's collection of filters.
 void removeFiltersNotIn(java.lang.String[] values)
          removes filters from the database's collection that aren't contained in this collection of names.
 void removeLotusFileObject(DefaultLotusFileObject value)
          removes a lotus file object from this application's collection of lotus file objects.
 void removeLotusFileObject(java.lang.String value, short version)
          removes a lotus file object from this server's collection of lotus file objects.
 void removeLotusFileObjectsNotIn(java.lang.String[] values, short version)
          removes lotus file objects from the applications collection that aren't contained in this collection of names.
 void removeOutlineFileObject(DefaultOutlineFileObject value)
          removes an outline file object from this application's collection of outline file objects.
 void removeOutlineFileObject(java.lang.String value)
          removes an outline file object from this server's collection of outline file objects.
 void removeOutlineFileObjectsNotIn(java.lang.String[] values)
          removes outline file objects from the applications collection that aren't contained in this collection of names.
 void removePartition(DefaultPartition value)
          removes a partition from this database's collection of partitions.
 void removePartitionsNotIn(DefaultPartition[] values)
          removes partition from the database's collection that aren't contained in this collection of partitions.
 void removeReportScript(DefaultReportScript value)
          removes a report script from this database's collection of calc scripts.
 void removeReportScript(java.lang.String value)
          removes a calc script from this database's collection of report scripts.
 void removeReportScriptsNotIn(java.lang.String[] values)
          removes report scripts from the database's collection that aren't contained in this collection of names.
 void removeRulesObject(DefaultRulesObject value)
          removes a rules object from this application's collection of rules objects.
 void removeRulesObject(java.lang.String value)
          removes a rules object from this server's collection of rules objects.
 void removeRulesObjectsNotIn(java.lang.String[] values)
          removes rules objects from the applications collection that aren't contained in this collection of names.
 void removeTextFileObject(DefaultTextFileObject value)
          removes a text file object from this application's collection of text file objects.
 void removeTextFileObject(java.lang.String value)
          removes a text file object from this server's collection of text file objects.
 void removeTextFileObjectsNotIn(java.lang.String[] values)
          removes text file objects from the applications collection that aren't contained in this collection of names.
 void removeVariable(Variable value)
          removes a Variable from this db's collection of Variables.
 void setApplication(Application value)
          set the application this database object is contained in.
 void setName(java.lang.String value)
          sets the name associated with this database.
 void setProperties(DatabaseProperties props)
          sets properties object associated with this database.
 void setPropertiesSubset(DatabaseProperties props, int propertiesSubset)
           
 void setPropertyLoaded(int property, boolean loaded)
           
 void setQueryTrackingEnabled(boolean enabled)
           
 void setStarted(boolean started)
          Set the started staus of the database.

 

Method Detail

getApplication

Application getApplication()
get the application this database object is contained in.

setApplication

void setApplication(Application value)
set the application this database object is contained in.

hasTargetPartition

boolean hasTargetPartition()

getTargetPartition

DefaultPartition getTargetPartition(java.lang.String host,
                                    java.lang.String hostIp,
                                    java.lang.String app,
                                    java.lang.String db,
                                    int type)
looks up the partition list for a partition that is the target partition for this db

getSourcePartition

DefaultPartition getSourcePartition(java.lang.String host,
                                    java.lang.String hostIp,
                                    java.lang.String app,
                                    java.lang.String db,
                                    int type)
looks up the partition list for a partition that is the source partition for this db

getPartition

DefaultPartition getPartition(java.lang.String srchost,
                              java.lang.String srcIp,
                              java.lang.String srcapp,
                              java.lang.String srcdb,
                              java.lang.String tgthost,
                              java.lang.String tgtIp,
                              java.lang.String tgtapp,
                              java.lang.String tgtdb,
                              int type)
looks up the partition for which either this is the source and the targer macthes the param or this is the target and the source is the param

existPartition

DefaultPartition existPartition(DefaultPartition part)
looks up the list of partitions which matches with the source, target and the type info of the partition

addPartition

void addPartition(DefaultPartition value)
                  throws DuplicatePartitionException
adds a partition to this database's collection.
Throws:
DuplicatePartitionException

partitionUpdated

void partitionUpdated(DefaultPartition value)
notifies all about the partition getting updated

getPartitions

DefaultPartition[] getPartitions()
retrieves this database's collection of partitions.

removePartition

void removePartition(DefaultPartition value)
                     throws MissingPartitionException
removes a partition from this database's collection of partitions.
Throws:
MissingPartitionException

removeAllPartitions

void removeAllPartitions()

removePartitionsNotIn

void removePartitionsNotIn(DefaultPartition[] values)
removes partition from the database's collection that aren't contained in this collection of partitions.

addCalcScript

void addCalcScript(DefaultCalcScript value)
                   throws DuplicateCalcScriptException
adds a calc script to this database's collection.
Throws:
DuplicateCalcScriptException

getCalcScripts

DefaultCalcScript[] getCalcScripts()
retrieves this database's collection of calc scripts.

getCalcScript

DefaultCalcScript getCalcScript(java.lang.String scriptName)

removeCalcScript

void removeCalcScript(DefaultCalcScript value)
                      throws MissingCalcScriptException
removes a calc script from this database's collection of calc scripts.
Throws:
MissingCalcScriptException

removeCalcScript

void removeCalcScript(java.lang.String value)
                      throws MissingCalcScriptException
removes a calc script from this database's collection of calc scripts.
Throws:
MissingCalcScriptException

removeCalcScriptsNotIn

void removeCalcScriptsNotIn(java.lang.String[] values)
removes calc scripts from the database's collection that aren't contained in this collection of names.

addFilter

void addFilter(Filter value)
               throws DuplicateFilterException
adds a filter to this database's collection.
Throws:
DuplicateFilterException

addFilters

void addFilters(Filter[] values)

getFilters

Filter[] getFilters()
retrieves this database's collection of filters.

getFilter

Filter getFilter(java.lang.String filterName)

removeFilter

void removeFilter(Filter value)
                  throws MissingFilterException
removes a filter from this database's collection of filters.
Throws:
MissingFilterException

removeFilter

void removeFilter(java.lang.String value)
                  throws MissingFilterException
removes a filter from this database's collection of filters.
Throws:
MissingFilterException

removeFiltersNotIn

void removeFiltersNotIn(java.lang.String[] values)
removes filters from the database's collection that aren't contained in this collection of names.

getName

java.lang.String getName()
returns the name associated with this database.

setName

void setName(java.lang.String value)
sets the name associated with this database.

getProperties

DatabaseProperties getProperties()
returns properties object associated with this database.

setProperties

void setProperties(DatabaseProperties props)
sets properties object associated with this database.

addDatabaseListener

void addDatabaseListener(DatabaseListener l)
adds a listener for events on an application.

removeDatabaseListener

void removeDatabaseListener(DatabaseListener l)
removes an event listener from an application

addReportScript

void addReportScript(DefaultReportScript value)
                     throws DuplicateReportScriptException
adds a report script to this database's collection.
Throws:
DuplicateReportScriptException

getReportScript

DefaultReportScript getReportScript(java.lang.String scriptName)

getReportScripts

DefaultReportScript[] getReportScripts()
retrieves this database's collection of report scripts.

removeReportScript

void removeReportScript(DefaultReportScript value)
                        throws MissingCalcScriptException
removes a report script from this database's collection of calc scripts.
Throws:
MissingCalcScriptException

removeReportScript

void removeReportScript(java.lang.String value)
                        throws MissingReportScriptException
removes a calc script from this database's collection of report scripts.
Throws:
MissingReportScriptException

removeReportScriptsNotIn

void removeReportScriptsNotIn(java.lang.String[] values)
removes report scripts from the database's collection that aren't contained in this collection of names.

setPropertiesSubset

void setPropertiesSubset(DatabaseProperties props,
                         int propertiesSubset)

getPropertiesSubset

DatabaseProperties getPropertiesSubset(int propertiesSubset)

getFullName

java.lang.String getFullName()
returns the full name associated with this database. <server>.<appname>.<dbname>

addRulesObject

void addRulesObject(DefaultRulesObject value)
                    throws DuplicateRulesObjectException
adds a rules object to this database's collection.
Throws:
DuplicateRulesObjectException

getRulesObject

DefaultRulesObject getRulesObject(java.lang.String scriptName)

getRulesObjects

DefaultRulesObject[] getRulesObjects()
retrieves this database's collection of rules objects.

removeRulesObject

void removeRulesObject(DefaultRulesObject value)
                       throws MissingRulesObjectException
removes a rules object from this application's collection of rules objects.
Throws:
MissingRulesObjectException

removeRulesObject

void removeRulesObject(java.lang.String value)
                       throws MissingRulesObjectException
removes a rules object from this server's collection of rules objects.
Throws:
MissingRulesObjectException

removeRulesObjectsNotIn

void removeRulesObjectsNotIn(java.lang.String[] values)
removes rules objects from the applications collection that aren't contained in this collection of names.

addVariable

void addVariable(Variable value)
                 throws DuplicateVariableException
adds a Variable to this db's collection.
Throws:
DuplicateVariableException

getVariables

Variable[] getVariables()
retrieves this db's collection of variables.

removeVariable

void removeVariable(Variable value)
                    throws MissingVariableException
removes a Variable from this db's collection of Variables.
Throws:
MissingVariableException

getVariable

Variable getVariable(java.lang.String name)
Returns the Variable associated with the name from the collection of variables

addTextFileObject

void addTextFileObject(DefaultTextFileObject value)
                       throws DuplicateTextFileObjectException
adds a text file object to this application's collection.
Throws:
DuplicateTextFileObjectException

getTextFileObject

DefaultTextFileObject getTextFileObject(java.lang.String value)

getTextFileObjects

DefaultTextFileObject[] getTextFileObjects()
retrieves this application's collection of text file objects.

removeTextFileObject

void removeTextFileObject(DefaultTextFileObject value)
                          throws MissingTextFileObjectException
removes a text file object from this application's collection of text file objects.
Throws:
MissingTextFileObjectException

removeTextFileObject

void removeTextFileObject(java.lang.String value)
                          throws MissingRulesObjectException
removes a text file object from this server's collection of text file objects.
Throws:
MissingRulesObjectException

removeTextFileObjectsNotIn

void removeTextFileObjectsNotIn(java.lang.String[] values)
removes text file objects from the applications collection that aren't contained in this collection of names.

getLotusFileObject

DefaultLotusFileObject getLotusFileObject(java.lang.String value,
                                          short version)

addLotusFileObject

void addLotusFileObject(DefaultLotusFileObject value)
                        throws DuplicateLotusFileObjectException
adds a lotus file object to this application's collection.
Throws:
DuplicateLotusFileObjectException

getLotusFileObjects

DefaultLotusFileObject[] getLotusFileObjects(short version)
retrieves this application's collection of lotus file objects.

removeLotusFileObject

void removeLotusFileObject(DefaultLotusFileObject value)
                           throws MissingLotusFileObjectException
removes a lotus file object from this application's collection of lotus file objects.
Throws:
MissingLotusFileObjectException

removeLotusFileObject

void removeLotusFileObject(java.lang.String value,
                           short version)
                           throws MissingRulesObjectException
removes a lotus file object from this server's collection of lotus file objects.
Throws:
MissingRulesObjectException

removeLotusFileObjectsNotIn

void removeLotusFileObjectsNotIn(java.lang.String[] values,
                                 short version)
removes lotus file objects from the applications collection that aren't contained in this collection of names.

getExcelFileObject

DefaultExcelFileObject getExcelFileObject(java.lang.String value)

addExcelFileObject

void addExcelFileObject(DefaultExcelFileObject value)
                        throws DuplicateExcelFileObjectException
adds a excel file object to this application's collection.
Throws:
DuplicateExcelFileObjectException

getExcelFileObjects

DefaultExcelFileObject[] getExcelFileObjects()
retrieves this application's collection of excel file objects.

removeExcelFileObject

void removeExcelFileObject(DefaultExcelFileObject value)
                           throws MissingExcelFileObjectException
removes a excel file object from this application's collection of excel file objects.
Throws:
MissingExcelFileObjectException

removeExcelFileObject

void removeExcelFileObject(java.lang.String value)
                           throws MissingExcelFileObjectException
removes a excel file object from this server's collection of excel file objects.
Throws:
MissingExcelFileObjectException

removeExcelFileObjectsNotIn

void removeExcelFileObjectsNotIn(java.lang.String[] values)
removes excel file objects from the applications collection that aren't contained in this collection of names.

getAliasTableFileObject

DefaultAliasTableFileObject getAliasTableFileObject(java.lang.String value)
gets a specific alias table file object from this application's collection.

addAliasTableFileObject

void addAliasTableFileObject(DefaultAliasTableFileObject value)
                             throws DuplicateAliasTableFileObjectException
adds a excel file object to this application's collection.
Throws:
DuplicateAliasTableFileObjectException

getAliasTableFileObjects

DefaultAliasTableFileObject[] getAliasTableFileObjects()
retrieves this application's collection of excel file objects.

removeAliasTableFileObject

void removeAliasTableFileObject(DefaultAliasTableFileObject value)
                                throws MissingAliasTableFileObjectException
removes a excel file object from this application's collection of excel file objects.
Throws:
MissingAliasTableFileObjectException

removeAliasTableFileObject

void removeAliasTableFileObject(java.lang.String value)
                                throws MissingAliasTableFileObjectException
removes a excel file object from this server's collection of excel file objects.
Throws:
MissingAliasTableFileObjectException

removeAliasTableFileObjectsNotIn

void removeAliasTableFileObjectsNotIn(java.lang.String[] values)
removes excel file objects from the applications collection that aren't contained in this collection of names.

getOutlineFileObject

DefaultOutlineFileObject getOutlineFileObject(java.lang.String value)
gets a specific outline file object from this application's collection.

addOutlineFileObject

void addOutlineFileObject(DefaultOutlineFileObject value)
                          throws DuplicateOutlineFileObjectException
adds an outline file object to this application's collection.
Throws:
DuplicateOutlineFileObjectException

getOutlineFileObjects

DefaultOutlineFileObject[] getOutlineFileObjects()
retrieves this application's collection of outline file objects.

removeOutlineFileObject

void removeOutlineFileObject(DefaultOutlineFileObject value)
                             throws MissingOutlineFileObjectException
removes an outline file object from this application's collection of outline file objects.
Throws:
MissingOutlineFileObjectException

removeOutlineFileObject

void removeOutlineFileObject(java.lang.String value)
                             throws MissingOutlineFileObjectException
removes an outline file object from this server's collection of outline file objects.
Throws:
MissingOutlineFileObjectException

removeOutlineFileObjectsNotIn

void removeOutlineFileObjectsNotIn(java.lang.String[] values)
removes outline file objects from the applications collection that aren't contained in this collection of names.

isPropertyLoaded

boolean isPropertyLoaded(int property)

setPropertyLoaded

void setPropertyLoaded(int property,
                       boolean loaded)

incFiltersAccess

void incFiltersAccess()
increments the filters list user access. used to keep list reference not null and in memory

decFiltersAccess

void decFiltersAccess()
decrements the filters list user access. used to free list reference in memory for potential garbage collection

setStarted

void setStarted(boolean started)
Set the started staus of the database.
Parameters:
started -

isStarted

boolean isStarted()

isQueryTrackingEnabled

boolean isQueryTrackingEnabled()

setQueryTrackingEnabled

void setQueryTrackingEnabled(boolean enabled)

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.