Skip navigation links


com.essbase.eas.essbase.defs
Class DatabaseProperties

java.lang.Object
  extended by com.essbase.eas.essbase.defs.DatabaseProperties

All Implemented Interfaces:
java.lang.Cloneable

public class DatabaseProperties
extends java.lang.Object
implements java.lang.Cloneable

Implements a platform-neutral representation of the properties for a database. This class consists of inner classes and set/get methods for the properties. It does not know how to retrieve values, or how to update them back to the Essbase server.

Since:
6.2.0
Version:
6.5.4
Author:
Hank Cox

Nested Class Summary
static class DatabaseProperties.DbFileInfo
           
 class DatabaseProperties.DbReqInfo
           
static class DatabaseProperties.Dimension
           
static class DatabaseProperties.DiskVolume
           

 

Field Summary
static short DB_COMPRESSION_BITMAP
           
static short DB_COMPRESSION_DISABLED
           
static short DB_COMPRESSION_RLE
           
static short DB_COMPRESSION_ZLIB
           
static int DB_FILE_ACEESS_BUFFERED
           
static int DB_FILE_ACEESS_DIRECT
           
static int DB_FILE_ACEESS_UNAVAILABLE
           
static int DB_PROPERTIES_CACHES
           
static int DB_PROPERTIES_CURRENCY
           
static int DB_PROPERTIES_DIMENSIONS
           
static int DB_PROPERTIES_GENERAL
           
static int DB_PROPERTIES_MODIFICATIONS
           
static int DB_PROPERTIES_STATISTICS
           
static int DB_PROPERTIES_STORAGE
           
static int DB_PROPERTIES_SUBSET_COUNT
           
static int DB_PROPERTIES_TRANSACTIONS
           
static int DB_TYPE_CURRENCY
           
static int DB_TYPE_NORMAL
           
static int NOWAIT_MODE
           
static int WAIT_MODE
           

 

Constructor Summary
DatabaseProperties()
           

 

Method Summary
 java.lang.Object clone()
           
 DatabaseProperties.DbFileInfo createDbFileInfo()
           
 DatabaseProperties.DbReqInfo createDbReqInfo()
           
 DatabaseProperties.Dimension createDimension()
           
 DatabaseProperties.DiskVolume createDiskVolume()
           
 boolean equals(int subset, DatabaseProperties props)
          Compare DatabaseProperties objects but only the fields that can be changed by the user
 boolean equals(java.lang.Object other)
          Compare DatabaseProperties objects but only the fields that can be changed by the user
 short getAccessLevel()
           
 int getAccessMode()
           
 java.util.ArrayList getASOStatistics()
           
 boolean getAutoLoad()
           
 double getBlockDensity()
           
 double getBlockSize()
           
 boolean getCacheMemLocking()
           
 boolean getCalcCreateBlock()
           
 boolean getCalcNoAggMissing()
           
 boolean getCalcNoAvgMissing()
           
 boolean getCalcTwoPass()
           
 double getClusterRatio()
           
 long getCommitBlocks()
           
 long getCommitRows()
           
 double getCompressionRatio()
           
 int getConnectionCount()
           
 java.lang.String getCurrencyCategoryDim()
           
 java.lang.String getCurrencyConvType()
           
 java.lang.String getCurrencyCountryDim()
           
 java.lang.String getCurrencyDbName()
           
 java.lang.String getCurrencyPartitionDim()
           
 java.lang.String getCurrencyTimeDim()
           
 java.lang.String getCurrencyTypeMember()
           
 long getDataCacheCurrent()
           
 long getDataCacheSetting()
           
 short getDataCompressionType()
           
 long getDataFileCacheCurrent()
           
 long getDataFileCacheSetting()
           
 short getDataState()
           
 java.util.ArrayList getDbFileInfo()
           
 java.lang.String getDescription()
           
 long getDimCount()
           
 java.util.ArrayList getDimensions()
           
 int getDirectIOWaitMode()
           
 java.util.ArrayList getDiskVolumeInfo()
           
 TimeRecord getElapsedDbTime()
           
 long getIndexCacheCurrent()
           
 long getIndexCacheSetting()
           
 long getIndexPageCurrent()
           
 long getIndexPageSetting()
           
 short getIsolationLevel()
           
 boolean getLoadable()
           
 java.util.ArrayList getModifications()
           
 double getNonMissingLeafBlocks()
           
 double getNonMissingNonLeafBlocks()
           
 int getPendingAccessMode()
           
 double getPotentialBlocks()
           
 boolean getPreImageAccess()
           
 int getPropertiesLoaded()
           
 int getPropertiesSubset()
           
 boolean getPropertiesSubsetLoaded(int propertiesSubset)
           
 long getRetrievalBuffer()
           
 long getRetrievalSortBuffer()
           
 java.util.ArrayList getRunTimeInfo()
           
 double getSparseDensity()
           
 TimeRecord getStatResetTime()
           
 long getTimeOut()
           
 double getTotalBlocks()
           
 short getType()
           
 boolean hasCurrencyDb()
           
 boolean isCurrency()
           
 boolean isNormal()
           
 void setAccessLevel(short level)
           
 void setAccessMode(int mode)
           
 void setASOStatistics(java.util.ArrayList val)
           
 void setAutoLoad(boolean load)
           
 void setBlockDensity(double density)
           
 void setBlockSize(double blockSize)
           
 void setCacheMemLocking(boolean lock)
           
 void setCachesProperties(DatabaseProperties props)
           
 void setCalcCreateBlock(boolean crBlk)
           
 void setCalcNoAggMissing(boolean agg)
           
 void setCalcNoAvgMissing(boolean noAvgMissing)
           
 void setCalcTwoPass(boolean twoPass)
           
 void setClusterRatio(double ratio)
           
 void setCommitBlocks(long blocks)
           
 void setCommitRows(long rows)
           
 void setCompressionRatio(double ratio)
           
 void setConnectionCount(int count)
           
 void setCurrencyCategoryDim(java.lang.String catDim)
           
 void setCurrencyConvType(java.lang.String convType)
           
 void setCurrencyCountryDim(java.lang.String cntyDim)
           
 void setCurrencyDbName(java.lang.String name)
           
 void setCurrencyPartitionDim(java.lang.String partDim)
           
 void setCurrencyProperties(DatabaseProperties props)
           
 void setCurrencyTimeDim(java.lang.String timeDim)
           
 void setCurrencyTypeMember(java.lang.String typeMember)
           
 void setDataCacheCurrent(long cache)
           
 void setDataCacheSetting(long cache)
           
 void setDataCompressionType(short type)
           
 void setDataFileCacheCurrent(long cache)
           
 void setDataFileCacheSetting(long cache)
           
 void setDataState(short state)
           
 void setDbFileInfo(java.util.ArrayList files)
           
 void setDescription(java.lang.String desc)
           
 void setDimCount(long count)
           
 void setDimensions(java.util.ArrayList dims)
           
 void setDimensionsProperties(DatabaseProperties props)
           
 void setDirectIOWaitMode(int mode)
           
 void setDiskVolumeInfo(java.util.ArrayList vols)
           
 void setElapsedDbTime(TimeRecord elpTime)
           
 void setGeneralProperties(DatabaseProperties props)
           
 void setIndexCacheCurrent(long cache)
           
 void setIndexCacheSetting(long cache)
           
 void setIndexPageCurrent(long page)
           
 void setIndexPageSetting(long page)
           
 void setIsolationLevel(short level)
           
 void setLoadable(boolean load)
           
 void setModifications(java.util.ArrayList mods)
           
 void setModificationsProperties(DatabaseProperties props)
           
 void setNonMissingLeafBlocks(double blocks)
           
 void setNonMissingNonLeafBlocks(double blocks)
           
 void setPendingAccessMode(int mode)
           
 void setPotentialBlocks(double blocks)
           
 void setPreImageAccess(boolean img)
           
 void setProperties(DatabaseProperties props)
           
 void setPropertiesLoaded(int prp)
           
 void setPropertiesSubset(DatabaseProperties props, int propertiesSubset)
           
 void setPropertiesSubset(int propertiesSubset)
           
 void setPropertiesSubsetLoaded(int propertiesSubset, boolean isLoaded)
           
 void setRetrievalBuffer(long buffer)
           
 void setRetrievalSortBuffer(long buffer)
           
 void setRunTimeInfo(java.util.ArrayList rtInfo)
           
 void setSparseDensity(double density)
           
 void setStatisticsProperties(DatabaseProperties props)
           
 void setStatResetTime(TimeRecord resetTime)
           
 void setStorageProperties(DatabaseProperties props)
           
 void setTimeOut(long time)
           
 void setTotalBlocks(double blocks)
           
 void setTransactionsProperties(DatabaseProperties props)
           
 void setType(short type)
           
 java.lang.String toString()
           

 

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

DB_PROPERTIES_GENERAL

public static final int DB_PROPERTIES_GENERAL
See Also:
Constant Field Values

DB_PROPERTIES_DIMENSIONS

public static final int DB_PROPERTIES_DIMENSIONS
See Also:
Constant Field Values

DB_PROPERTIES_STATISTICS

public static final int DB_PROPERTIES_STATISTICS
See Also:
Constant Field Values

DB_PROPERTIES_CACHES

public static final int DB_PROPERTIES_CACHES
See Also:
Constant Field Values

DB_PROPERTIES_TRANSACTIONS

public static final int DB_PROPERTIES_TRANSACTIONS
See Also:
Constant Field Values

DB_PROPERTIES_STORAGE

public static final int DB_PROPERTIES_STORAGE
See Also:
Constant Field Values

DB_PROPERTIES_CURRENCY

public static final int DB_PROPERTIES_CURRENCY
See Also:
Constant Field Values

DB_PROPERTIES_MODIFICATIONS

public static final int DB_PROPERTIES_MODIFICATIONS
See Also:
Constant Field Values

DB_FILE_ACEESS_UNAVAILABLE

public static final int DB_FILE_ACEESS_UNAVAILABLE
See Also:
Constant Field Values

DB_FILE_ACEESS_BUFFERED

public static final int DB_FILE_ACEESS_BUFFERED
See Also:
Constant Field Values

DB_FILE_ACEESS_DIRECT

public static final int DB_FILE_ACEESS_DIRECT
See Also:
Constant Field Values

WAIT_MODE

public static final int WAIT_MODE
See Also:
Constant Field Values

NOWAIT_MODE

public static final int NOWAIT_MODE
See Also:
Constant Field Values

DB_TYPE_NORMAL

public static final int DB_TYPE_NORMAL
See Also:
Constant Field Values

DB_TYPE_CURRENCY

public static final int DB_TYPE_CURRENCY
See Also:
Constant Field Values

DB_COMPRESSION_DISABLED

public static final short DB_COMPRESSION_DISABLED
See Also:
Constant Field Values

DB_COMPRESSION_RLE

public static final short DB_COMPRESSION_RLE
See Also:
Constant Field Values

DB_COMPRESSION_BITMAP

public static final short DB_COMPRESSION_BITMAP
See Also:
Constant Field Values

DB_COMPRESSION_ZLIB

public static final short DB_COMPRESSION_ZLIB
See Also:
Constant Field Values

DB_PROPERTIES_SUBSET_COUNT

public static final int DB_PROPERTIES_SUBSET_COUNT
See Also:
Constant Field Values

Constructor Detail

DatabaseProperties

public DatabaseProperties()

Method Detail

setPropertiesSubset

public void setPropertiesSubset(int propertiesSubset)

getPropertiesSubset

public int getPropertiesSubset()

setPropertiesSubsetLoaded

public void setPropertiesSubsetLoaded(int propertiesSubset,
                                      boolean isLoaded)

setPropertiesSubset

public void setPropertiesSubset(DatabaseProperties props,
                                int propertiesSubset)

getPropertiesSubsetLoaded

public boolean getPropertiesSubsetLoaded(int propertiesSubset)

getPropertiesLoaded

public int getPropertiesLoaded()

setPropertiesLoaded

public void setPropertiesLoaded(int prp)

setDescription

public void setDescription(java.lang.String desc)

getDescription

public java.lang.String getDescription()

setType

public void setType(short type)

getType

public short getType()

getDataState

public short getDataState()

setDataState

public void setDataState(short state)

setAutoLoad

public void setAutoLoad(boolean load)

getAutoLoad

public boolean getAutoLoad()

setLoadable

public void setLoadable(boolean load)

getLoadable

public boolean getLoadable()

setCalcNoAggMissing

public void setCalcNoAggMissing(boolean agg)

getCalcNoAggMissing

public boolean getCalcNoAggMissing()

setCalcCreateBlock

public void setCalcCreateBlock(boolean crBlk)

getCalcCreateBlock

public boolean getCalcCreateBlock()

setCalcNoAvgMissing

public void setCalcNoAvgMissing(boolean noAvgMissing)

getCalcNoAvgMissing

public boolean getCalcNoAvgMissing()

setCalcTwoPass

public void setCalcTwoPass(boolean twoPass)

getCalcTwoPass

public boolean getCalcTwoPass()

setAccessLevel

public void setAccessLevel(short level)

getAccessLevel

public short getAccessLevel()

setRetrievalBuffer

public void setRetrievalBuffer(long buffer)

getRetrievalBuffer

public long getRetrievalBuffer()

setRetrievalSortBuffer

public void setRetrievalSortBuffer(long buffer)

getRetrievalSortBuffer

public long getRetrievalSortBuffer()

setDimCount

public void setDimCount(long count)

getDimCount

public long getDimCount()

setDimensions

public void setDimensions(java.util.ArrayList dims)

getDimensions

public java.util.ArrayList getDimensions()

createDimension

public DatabaseProperties.Dimension createDimension()

setElapsedDbTime

public void setElapsedDbTime(TimeRecord elpTime)

getElapsedDbTime

public TimeRecord getElapsedDbTime()

setConnectionCount

public void setConnectionCount(int count)

getConnectionCount

public int getConnectionCount()

setStatResetTime

public void setStatResetTime(TimeRecord resetTime)

getStatResetTime

public TimeRecord getStatResetTime()

setASOStatistics

public void setASOStatistics(java.util.ArrayList val)

getASOStatistics

public java.util.ArrayList getASOStatistics()

getAccessMode

public int getAccessMode()

setAccessMode

public void setAccessMode(int mode)

getPendingAccessMode

public int getPendingAccessMode()

setPendingAccessMode

public void setPendingAccessMode(int mode)

getDirectIOWaitMode

public int getDirectIOWaitMode()

setDirectIOWaitMode

public void setDirectIOWaitMode(int mode)

setTotalBlocks

public void setTotalBlocks(double blocks)

getTotalBlocks

public double getTotalBlocks()

setBlockSize

public void setBlockSize(double blockSize)

getBlockSize

public double getBlockSize()

setPotentialBlocks

public void setPotentialBlocks(double blocks)

getPotentialBlocks

public double getPotentialBlocks()

setNonMissingLeafBlocks

public void setNonMissingLeafBlocks(double blocks)

getNonMissingLeafBlocks

public double getNonMissingLeafBlocks()

setNonMissingNonLeafBlocks

public void setNonMissingNonLeafBlocks(double blocks)

getNonMissingNonLeafBlocks

public double getNonMissingNonLeafBlocks()

setBlockDensity

public void setBlockDensity(double density)

getBlockDensity

public double getBlockDensity()

setSparseDensity

public void setSparseDensity(double density)

getSparseDensity

public double getSparseDensity()

setCompressionRatio

public void setCompressionRatio(double ratio)

getCompressionRatio

public double getCompressionRatio()

setClusterRatio

public void setClusterRatio(double ratio)

getClusterRatio

public double getClusterRatio()

setRunTimeInfo

public void setRunTimeInfo(java.util.ArrayList rtInfo)

getRunTimeInfo

public java.util.ArrayList getRunTimeInfo()

setDataFileCacheSetting

public void setDataFileCacheSetting(long cache)

getDataFileCacheSetting

public long getDataFileCacheSetting()

setDataCacheSetting

public void setDataCacheSetting(long cache)

getDataCacheSetting

public long getDataCacheSetting()

setIndexCacheSetting

public void setIndexCacheSetting(long cache)

getIndexCacheSetting

public long getIndexCacheSetting()

setIndexPageSetting

public void setIndexPageSetting(long page)

getIndexPageSetting

public long getIndexPageSetting()

setDataFileCacheCurrent

public void setDataFileCacheCurrent(long cache)

getDataFileCacheCurrent

public long getDataFileCacheCurrent()

setDataCacheCurrent

public void setDataCacheCurrent(long cache)

getDataCacheCurrent

public long getDataCacheCurrent()

setIndexCacheCurrent

public void setIndexCacheCurrent(long cache)

getIndexCacheCurrent

public long getIndexCacheCurrent()

setIndexPageCurrent

public void setIndexPageCurrent(long page)

getIndexPageCurrent

public long getIndexPageCurrent()

setCacheMemLocking

public void setCacheMemLocking(boolean lock)

getCacheMemLocking

public boolean getCacheMemLocking()

setDataCompressionType

public void setDataCompressionType(short type)

getDataCompressionType

public short getDataCompressionType()

setDiskVolumeInfo

public void setDiskVolumeInfo(java.util.ArrayList vols)

getDiskVolumeInfo

public java.util.ArrayList getDiskVolumeInfo()

setDbFileInfo

public void setDbFileInfo(java.util.ArrayList files)

getDbFileInfo

public java.util.ArrayList getDbFileInfo()

createDiskVolume

public DatabaseProperties.DiskVolume createDiskVolume()

createDbFileInfo

public DatabaseProperties.DbFileInfo createDbFileInfo()

setCurrencyDbName

public void setCurrencyDbName(java.lang.String name)

getCurrencyDbName

public java.lang.String getCurrencyDbName()

setCurrencyTypeMember

public void setCurrencyTypeMember(java.lang.String typeMember)

getCurrencyTypeMember

public java.lang.String getCurrencyTypeMember()

setCurrencyConvType

public void setCurrencyConvType(java.lang.String convType)

getCurrencyConvType

public java.lang.String getCurrencyConvType()

setCurrencyCountryDim

public void setCurrencyCountryDim(java.lang.String cntyDim)

getCurrencyCountryDim

public java.lang.String getCurrencyCountryDim()

setCurrencyTimeDim

public void setCurrencyTimeDim(java.lang.String timeDim)

getCurrencyTimeDim

public java.lang.String getCurrencyTimeDim()

setCurrencyCategoryDim

public void setCurrencyCategoryDim(java.lang.String catDim)

getCurrencyCategoryDim

public java.lang.String getCurrencyCategoryDim()

setCurrencyPartitionDim

public void setCurrencyPartitionDim(java.lang.String partDim)

getCurrencyPartitionDim

public java.lang.String getCurrencyPartitionDim()

createDbReqInfo

public DatabaseProperties.DbReqInfo createDbReqInfo()

setModifications

public void setModifications(java.util.ArrayList mods)

getModifications

public java.util.ArrayList getModifications()

setIsolationLevel

public void setIsolationLevel(short level)

getIsolationLevel

public short getIsolationLevel()

setCommitBlocks

public void setCommitBlocks(long blocks)

getCommitBlocks

public long getCommitBlocks()

setCommitRows

public void setCommitRows(long rows)

getCommitRows

public long getCommitRows()

setPreImageAccess

public void setPreImageAccess(boolean img)

getPreImageAccess

public boolean getPreImageAccess()

setTimeOut

public void setTimeOut(long time)

getTimeOut

public long getTimeOut()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

setGeneralProperties

public void setGeneralProperties(DatabaseProperties props)

setDimensionsProperties

public void setDimensionsProperties(DatabaseProperties props)

setStatisticsProperties

public void setStatisticsProperties(DatabaseProperties props)

setCachesProperties

public void setCachesProperties(DatabaseProperties props)

setTransactionsProperties

public void setTransactionsProperties(DatabaseProperties props)

setStorageProperties

public void setStorageProperties(DatabaseProperties props)

setCurrencyProperties

public void setCurrencyProperties(DatabaseProperties props)

setModificationsProperties

public void setModificationsProperties(DatabaseProperties props)

hasCurrencyDb

public boolean hasCurrencyDb()

isNormal

public boolean isNormal()

isCurrency

public boolean isCurrency()

equals

public boolean equals(java.lang.Object other)
Compare DatabaseProperties objects but only the fields that can be changed by the user
Overrides:
equals in class java.lang.Object
Parameters:
other - the object to compare to
Returns:
true if thecompared fields are equal

equals

public boolean equals(int subset,
                      DatabaseProperties props)
Compare DatabaseProperties objects but only the fields that can be changed by the user
Parameters:
other - the object to compare to
Returns:
true if thecompared fields are equal

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

setProperties

public void setProperties(DatabaseProperties props)

Skip navigation links


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