|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssCube is the olap cube.
Nested Class Summary | |
static class |
IEssCube.EEssCubeAccess
The EEssCubeAccess is an enumeration of cube access levels. |
static class |
IEssCube.EEssCubeType
The EEssCubeType class. |
static class |
IEssCube.EEssCurrencyConversionType
The EEssCurrencyConversionType class. |
static class |
IEssCube.EEssDataLevel
The EEssDataLevel class is an enumeration of data level on export. |
static class |
IEssCube.EEssDataLoadStatus
The EEssDataLoadStatus class. |
static class |
IEssCube.EEssLoadStatus
The EEssLoadStatus class is an enumeration of Cube load status. |
static class |
IEssCube.EEssRestructureOption
The EEssRestructureOption class is an enumeration of Cube restructure options. |
static interface |
IEssCube.IEssCubeLock
The IEssCubeLock interface provides information about the data blocks exclusively locked. |
static interface |
IEssCube.IEssSecurityFilter
The IEssSecurityFilter is cube security filter. |
Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
Nested classes inherited from class com.essbase.api.domain.IEssAppComponent |
IEssAppComponent.EEssAppComponentType |
Method Summary | |
void |
archiveBegin(java.lang.String archFileName)
Prepares this cube for archive by setting read-only status. |
void |
archiveEnd()
After archive, returns cube status to read-write. |
void |
buildDimension(java.lang.String rulesFileName,
int rulesFileType,
java.lang.String dataFileName,
int dataFileType,
java.lang.String errOutFile)
Allows the addition or removal of members from the outline in the active cube from a data file and rules file. |
void |
calculate()
Executes the default calculation for this cube. |
void |
calculate(boolean syntaxCheckOnly,
java.lang.String calcFileNamePrefix)
Executes a calc script against the active database from a file. |
void |
calculate(java.lang.String calcScript,
boolean syntaxCheckOnly)
Sends and optionally executes a calc script against this active cube as a single string. |
void |
clearActive()
Clears the currently active application and cube for the instance of the IEssOlapServer object (which is parent of parent to this object). |
void |
clearAllData()
Clears all loaded data in the active cube. |
IEssCube |
copy(java.lang.String newCubeName,
IEssOlapApplication destApp)
Copies this cube to a new cube, including all associated objects and also starts the new cube. |
void |
copyOlapFileObject(int objType,
java.lang.String objName,
java.lang.String destAppName,
java.lang.String destCubeName,
java.lang.String destObjName)
Copies an olap file object. |
void |
copyOlapFileObjectFromServer(int objType,
java.lang.String objName,
java.lang.String clientFileName,
boolean lock)
Copies an object from the olap server to a client file and optionally locks the server object to prevent updates by others. |
void |
copyOlapFileObjectToServer(int objType,
java.lang.String objName,
java.lang.String clientFileName,
boolean unlock)
Copies an object from a client file to the olap server, and optionally unlocks the server object to allow updates by others. |
void |
createCDF(java.lang.String appName,
java.lang.String name,
java.lang.String javaSpec,
int options,
java.lang.String spec,
java.lang.String comment)
Creates custom defined function. |
void |
createCDM(java.lang.String appName,
java.lang.String name,
java.lang.String definition,
java.lang.String signature,
java.lang.String spec,
java.lang.String comment)
Creates custom defined macro. |
void |
createLocationAlias(java.lang.String aliasName,
java.lang.String hostName,
java.lang.String appName,
java.lang.String cubeName,
java.lang.String userName,
java.lang.String password)
Creates a new location alias; that is, it maps an alias name string to an ordered set of the following five strings: host name, application name, database name, user login name, and user password. |
void |
createOlapFileObject(int objType,
java.lang.String objName)
Creates a new olap file object. |
IEssCube.IEssSecurityFilter |
createSecurityFilter(java.lang.String filterName)
Creates a security filter. |
void |
delete()
Deletes this cube. |
void |
deleteAliasTable(java.lang.String aliasTableName)
Removes an alias table from the active database. |
void |
deleteAllAliasTables()
Clears all alias tables for the active cube. |
void |
deleteCDF(java.lang.String appName,
java.lang.String name)
Deletes custom defined function. |
void |
deleteCDM(java.lang.String appName,
java.lang.String name)
Deletes custom defined macro. |
void |
deleteLocationAlias(java.lang.String aliasName)
Deletes an existing location alias. |
void |
deleteOlapFileObject(int objType,
java.lang.String objName)
Delte an existing olap file object. |
void |
deleteSecurityFilter(java.lang.String filterName)
Deletes a security filter. |
void |
exportData(java.lang.String fileName,
IEssCube.EEssDataLevel dataLevel,
boolean columns)
Exports this cube's data to a text file. |
void |
exportData(java.lang.String fileName,
IEssCube.EEssDataLevel dataLevel,
short columns)
Deprecated. Use the other exportData method. |
int |
getActualBlockSize()
Gets the actual block size. |
double |
getActualMaxBlocks()
Gets the actual maximum number of blocks in the Cube. |
java.lang.String[][] |
getAliasTableEntries(java.lang.String aliasTableName)
Gets the contents of the specified alias table in the active database. |
java.lang.String |
getAliasTableName()
Gets the active alias table name from the active database for a user. |
java.lang.String[] |
getAliasTableNames()
Gets all the alias table names in this cube. |
IEssOlapApplication |
getApplication()
Gets the parent application. |
java.lang.String |
getApplicationName()
Gets the parent application name. |
java.lang.String[][] |
getAssociatedAttributes(java.lang.String baseMbrName,
java.lang.String attrDimName)
Gets the attribute members associated with a given base member. |
double |
getBlockDensity()
Gets the average Cube block density (calculated using all currently loaded blocks). |
java.lang.String |
getCalcFunctions()
Gets all calculator functions available in the application. |
java.lang.String[][] |
getCDM_CDF(java.lang.String appName)
Gets custom defined functions/macros. |
double |
getCompressionRatio()
Gets the average data block compression ratio on the disk. |
int |
getCountDimensions()
Gets the number of dimensions in the cube. |
int |
getCountLocks()
Gets the number of data blocks currently exclusively locked. |
int |
getCountUsersConnected()
Gets the number of users currently connected to the cube. |
IEssCube.EEssCubeAccess |
getCubeAccess()
Gets the cube access. |
IEssCube.EEssLoadStatus |
getCubeLoadStatus()
Gets cube load status. |
IEssCube.EEssCubeType |
getCubeType()
Gets the cube type. |
java.lang.String |
getCurrencyCategoryMemberName()
Gets the currency category dimension member. |
IEssCube.EEssCurrencyConversionType |
getCurrencyConvType()
Gets the currency conversion type (whether currency conversions are calculated by multiplication or division). |
java.lang.String |
getCurrencyConvTypeMemberName()
Gets the name of currency conversion type member (valid in non-currency cubes). |
java.lang.String |
getCurrencyCountryMemberName()
Gets the currency country dimension member. |
java.lang.String |
getCurrencyCubeName()
The name of associated currency cube (valid in non-currency Cubes). |
java.lang.String |
getCurrencyPartitionMemberName()
Gets the currency partition member (non-currency cube only). |
java.lang.String |
getCurrencyTimeMemberName()
Gets the currency time dimension member name. |
java.lang.String |
getCurrencyTypeMemberName()
Gets the currency type dimension member (currency cube only). |
int |
getDataCacheSize()
Gets the run-time data cache size (in Kbytes) currently in use by cube. |
IEssCube.EEssDataLoadStatus |
getDataLoadStatus()
Gets loading state of the data in the cube. |
int |
getDeclaredBlockSize()
Gets the declared data block size. |
double |
getDeclaredMaxBlocks()
Gets the declared maximum number of blocks in the Cube. |
int |
getDefaultAccessLevel()
Gets the default access level to the cube. |
java.lang.String |
getDefaultCalcScript()
Gets the default calc script for this active cube. |
java.lang.String |
getDescription()
Gets the cube description. |
IEssDimension |
getDimension(java.lang.String dimName)
Gets the dimension. |
IEssIterator |
getDimensions()
Gets the list of dimensions. |
int |
getElapsedCubeTime()
Gets the number of seconds the cube has been loaded. |
double |
getExclusiveLockCount()
Gets the number of cube blocks currently exclusively locked. |
int |
getIndexCacheSize()
Gets the index cache size. |
int |
getIndexPageSize()
Gets the size of index page in which buffer pool is constructed in (in bytes). |
double |
getInMemCompBlocks()
Gets the number of Cube blocks currently paged into compressed memory. |
java.lang.String[][] |
getLocationAliases()
Gets a list of all currently defined location aliases, together with lists of the host names, application names, database names and user names to which the location aliases are mapped. |
IEssIterator |
getLocks()
Get the list of locks held on a cube. |
int |
getMaxMemNonCompBlocks()
Gets the maximum memory reserved for non-compressed data blocks in the cube(in bytes). |
IEssMember |
getMember(java.lang.String mbrName)
Gets the member. |
java.lang.String[] |
getMemberCalc(java.lang.String mbrName)
Gets the calc equation for a specific member in the active cube outline. |
java.lang.String |
getName()
Gets the cube name. |
double |
getNonExclusiveLockCount()
Gets the number of cube blocks currently non-exclusively locked. |
double |
getNonMissingLeafBlocks()
Gets the number of non-missing leaf (lowest level) blocks in the cube. |
double |
getNonMissingNonLeafBlocks()
Gets the number of non-missing, non-leaf (upper level) blocks in the cube. |
java.lang.String |
getNoteOfTheDay()
Gets this cube's note-of-the-day message. |
IEssOlapFileObject |
getOlapFileObject(int objType,
java.lang.String objName)
Gets information about a specified olap store file object. |
IEssIterator |
getOlapFileObjects(int objType)
Gets all the olap store file objects of the types specified. |
IEssIterator |
getOpenCubeViews()
Gets the list of open cube views. |
IEssCubeOutline |
getOutline()
Deprecated. This method is replaced by openOutline() method. |
double |
getPagedInBlocks()
Gets the total number of cube blocks currently paged into memory. |
double |
getPagedOutBlocks()
Gets the number of cube blocks currently paged out to disk. |
java.lang.String |
getPerformanceStatistics()
Gets the performance statistics. |
IEssCube.IEssSecurityFilter |
getSecurityFilter(java.lang.String filterName)
Gets the security filter. |
IEssIterator |
getSecurityFilters()
Gets all the security filters. |
double |
getSparseDensity()
Gets the average density of the sparse dimensions in the Cube. |
double |
getTotalBlocks()
Gets the total number of existing data blocks (not the maximum). |
double |
getTotMemBlocks()
Gets the total memory used for all Cube blocks. |
double |
getTotMemIndex()
Gets the total memory used for the cube index. |
double |
getTotMemInMemCompBlocks()
Gets the total memory used for Cube blocks currently paged into compressed memory. |
double |
getTotMemPagedInBlocks()
Gets the total memory used for all paged-in (uncompressed) cube blocks. |
IEssCube.EEssCubeAccess |
getUserOrGroupAccess(java.lang.String userOrGroupName)
Gets the user or group access for this cube. |
boolean |
isActive()
Checks if this cube is currently active for the instance of the IEssOlapServer object (which is parent of parent to this object). |
boolean |
isAutoLoad()
Checks if the Cube will be loaded automatically be loaded when the application is started. |
boolean |
isCalcCreateBlock()
Checks if to force creation of data block on constant assignment calc equation (only valid for sparse dimensions). |
boolean |
isCalcNoAggMissing()
Checks flag to suppress aggregation of members if all their children are missing. |
boolean |
isCalcNoAvgMissing()
Checks if to suppress inclusion of missing members in calculating averages (true if missing values are not included). |
boolean |
isCalcTwoPass()
Checks if to force two pass calculation when running full calculation of the cube. |
boolean |
isDataCompress()
Checks flag to determine whether to compress blocks for this Cube. |
boolean |
isLoadable()
Checks if the cube can be loaded/started. |
boolean |
isSpanRelationalSource()
Checks if span relational source flag is set or not. |
boolean |
isValidMember(java.lang.String mbrName)
Checks if a string is a valid member name within the active cube outline. |
void |
loadAliasTable(java.lang.String aliasTableName,
java.lang.String fileName)
Loads an alias table for the active database from a structured text file. |
void |
loadData(boolean store,
boolean unlock,
java.lang.String updSpec)
Updates data to cube from the specification string. |
void |
loadData(int rulesObjType,
java.lang.String rulesFileName,
int dataObjType,
java.lang.String dataFileName,
boolean abortOnError)
Allows the importing of data from text files to this cube. |
java.lang.String[][] |
loadData(java.lang.String updateSpecs,
int rulesObjType,
java.lang.String rulesFileName,
boolean syntaxCheckOnly,
boolean unlockAfterUpdate,
boolean abortOnError)
Updates data to the cube from the specified update specification string. |
void |
lockOlapFileObject(int objType,
java.lang.String objName)
Locks an object on the server to prevent other users from updating it. |
IEssCubeView |
openCubeView(java.lang.String name)
Opens a cube view. |
IEssCubeView |
openCubeView(java.lang.String name,
boolean useConnPool,
boolean connPerOp,
boolean useCluster,
boolean readOnly)
Opens a cube view. |
IEssMemberSelection |
openMemberSelection(java.lang.String name)
Opens a member selection. |
IEssMemberSelection |
openMemberSelection(java.lang.String name,
boolean queryOverCache)
Opens a member selection. |
IEssCubeOutline |
openOutline()
Opens the cube outline in read-only mode. |
IEssCubeOutline |
openOutline(boolean readOnly,
boolean lock,
boolean keepTrans)
Opens the cube outline in read-only or read-write mode. |
java.lang.String |
queryMembers(java.lang.String mbrQuery)
Performs a report-style query to list a selection of cube member information. |
void |
refreshPropertyValues()
Refreshes the property values. |
void |
rename(java.lang.String newCubeName)
Renames this cube. |
void |
renameOlapFileObject(int objType,
java.lang.String objName,
java.lang.String newObjName)
Renames an existing olap file object. |
java.lang.String |
report(boolean output,
boolean lockForUpdate,
java.lang.String reportFileName,
boolean isLocalFile)
Sends a report specification to this active cube from a file. |
java.lang.String |
report(java.lang.String reportSpec,
boolean output,
boolean lockForUpdate)
Sends a report specification to the active database as a single string. |
IEssSequentialIterator |
report(java.lang.String reportSpecOrFileName,
boolean isFileName,
boolean isLocalFile,
boolean output,
boolean lockForUpdate)
Sends a report specification to the active database as a single string or from a file. |
void |
resetPerformanceStatisticsTables(int persistence,
int scope)
Resets values in the performance statistics tables to zero. |
void |
setActive()
Sets this cube active for the instance of the IEssOlapServer object (which is parent of parent to this object). |
void |
setAliasTableName(java.lang.String aliasTableName)
Sets the active alias table in the active database for a user. |
void |
setAutoLoad(boolean autoLoad)
Sets whether the Cube will be loaded automatically when the application is started. |
void |
setCalcCreateBlock(boolean value)
Sets flag to force creation of data block on constant assignment calc equation (only valid for sparse dimensions). |
void |
setCalcNoAggMissing(boolean value)
Sets to suppress aggregation of members if all their children are missing. |
void |
setCalcNoAvgMissing(boolean value)
Sets to suppress inclusion of missing members in calculating averages. |
void |
setCalcTwoPass(boolean twoPass)
Sets to force two pass calculation when running full calculation of cube. |
void |
setCubeAccess(IEssCube.EEssCubeAccess access)
Sets the cube access. |
void |
setCurrencyConvType(IEssCube.EEssCurrencyConversionType convType)
Sets the currency conversion type (whether currency conversions are calculated by multiplication or division). |
void |
setCurrencyConvTypeMemberName(java.lang.String mbrName)
Sets the name of currency conversion type member (valid in non-currency cubes). |
void |
setCurrencyCubeName(java.lang.String dbName)
Sets the name of associated currency cube (valid in non-currency cCubes). |
void |
setDataCompress(boolean dataCompress)
Sets flag to determine whether to compress blocks for this cube. |
void |
setDefaultAccessLevel(int accessLevel)
Sets the default access level to the cube. |
void |
setDefaultCalcScript(boolean isFileName,
java.lang.String defCalcScriptOrFile)
Sets the default calc script for this active cube. |
void |
setDescription(java.lang.String desc)
Sets the cube description. |
void |
setIndexPageSize(int size)
Sets the size of index page in which buffer pool is constructed in (in bytes). |
void |
setLoadable(boolean lodable)
Sets if the cube can be loaded/started. |
void |
setMaxMemNonCompBlocks(int memSize)
Sets the maximum memory reserved for non-compressed data blocks in the cube(in bytes). |
void |
setNoteOfTheDay(java.lang.String note)
Sets this cube's note-of-the-day message. |
void |
setSpanRelationalSource(boolean span)
Sets (or clears) an intenal boolean field informing essbase that pertinent data exists (or not exists) in an attached relational store. |
void |
setUserOrGroupAccess(java.lang.String userOrGroupName,
IEssCube.EEssCubeAccess access)
Sets the user or group access for this cube. |
void |
start()
Starts/Loads a cube within an Application on the server. |
void |
stop()
Stops/Unloads a cube within an application on the server. |
void |
unlockOlapFileObject(int objType,
java.lang.String objName)
Unlocks a locked object on the server. |
void |
updatePropertyValues()
Updates the property values. |
void |
validateCube(java.lang.String errLogFileName)
Checks the cube for data integrity. |
boolean |
verifyFormula(java.lang.String formulaName)
Verified the formula. |
Methods inherited from interface com.essbase.api.base.IEssExtendedObject |
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled |
Methods inherited from interface com.essbase.api.base.IEssProperties |
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny |
Methods inherited from interface com.essbase.api.domain.IEssAppComponent |
getAppComponentType |
Methods inherited from interface com.essbase.api.datasource.IEssSubstitutionVariables |
createSubstitutionVariable, deleteSubstitutionVariable, getSubstitutionVariables, getSubstitutionVariableValue |
Field Detail |
public static final int PROP_NAME
public static final int PROP_DESCRIPTION
public static final int PROP_IS_LODABLE
public static final int PROP_IS_AUTOLOAD
public static final int PROP_CUBE_ACCESS
public static final int PROP_MAX_MEM_NON_COMP_BLOCKS
public static final int PROP_IS_CALC_NO_AGG_MISSING
public static final int PROP_IS_CALC_NO_AVG_MISSING
public static final int PROP_IS_CALC_TWO_PASS
public static final int PROP_DATA_COMPRESS
public static final int PROP_CALC_CREATE_BLOCK
public static final int PROP_CURRENCY_CUBE_NAME
public static final int PROP_CURRENCY_CONV_TYPE_MEMBER_NAME
public static final int PROP_CURRENCY_CONV_TYPE
public static final int PROP_INDEX_PAGE_SIZE
public static final int PROP_INDEX_CACHE_SIZE
public static final int PROP_APPLICATION_NAME
public static final int PROP_CUBE_TYPE
public static final int PROP_CUBE_LOAD_STATUS
public static final int PROP_COUNT_OF_USERS_CONNECTED
public static final int PROP_COUNT_OF_LOCKS
public static final int PROP_COUNT_OF_DIMENSIONS
public static final int PROP_DATA_LOAD_STATUS
public static final int PROP_ELAPSED_CUBE_TIME
public static final int PROP_CURRENCY_COUNTRY_MEMBER
public static final int PROP_CURRENCY_TIME_MEMBER
public static final int PROP_CURRENCY_CATEGORY_MEMBER
public static final int PROP_CURRENCY_PARTITION_MEMBER
public static final int PROP_CURRENCY_TYPE_MEMBER
public static final int PROP_DATA_CACHE_SIZE
public static final int PROP_DECLARED_BLOCK_SIZE
public static final int PROP_ACTUAL_BLOCK_SIZE
public static final int PROP_DECLARED_MAX_BLOCKS
public static final int PROP_ACTUAL_MAX_BLOCKS
public static final int PROP_NON_MISSING_LEAF_BLOCKS
public static final int PROP_PAGED_OUT_BLOCKS
public static final int PROP_PAGED_IN_BLOCKS
public static final int PROP_TOTAL_BLOCKS
public static final int PROP_NON_EXCLUSIVE_LOCK_COUNT
public static final int PROP_EXCLUSIVE_LOCK_COUNT
public static final int PROP_TOTAL_MEMORY_PAGED_IN_BLOCKS
public static final int PROP_TOTAL_MEMORY_ALL_BLOCKS
public static final int PROP_TOTAL_MEMORY_FOR_INDEX
public static final int PROP_COUNT_OF_NON_MISSING_NON_LEAF_BLOCKS
public static final int PROP_BLOCK_DENSITY
public static final int PROP_SPARSE_DENSITY
public static final int PROP_COMPRESSION_RATIO
public static final int PROP_COUNT_OF_INMEM_COMPRESSED_BLOCKS
public static final int PROP_TOTAL_MEMORY_FOR_INMEM_COMPRESSED_BLOCKS
public static final int s_countProperties
public static final java.lang.String[] s_propNames
public static final IEssValueAny.EEssDataType[] s_propDataTypes
public static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
public java.lang.String getName() throws EssException
getName
in interface IEssExtendedObject
EssException
- if an error occurs.public java.lang.String getDescription() throws EssException
EssException
- if an error occurs..public void setDescription(java.lang.String desc) throws EssException
desc
- The cube description.
EssException
- if an error occurs..public boolean isLoadable() throws EssException
EssException
- if an error occurs..public void setLoadable(boolean lodable) throws EssException
EssException
- if an error occurs..public boolean isAutoLoad() throws EssException
EssException
- if an error occurs..public void setAutoLoad(boolean autoLoad) throws EssException
autoLoad
- true if the Cube will be automatically loaded.
EssException
- if an error occurs..public IEssCube.EEssCubeAccess getCubeAccess() throws EssException
EssException
- if an error occurs.public void setCubeAccess(IEssCube.EEssCubeAccess access) throws EssException
access
- The cube access.
EssException
- if an error occurs.public int getMaxMemNonCompBlocks() throws EssException
EssException
- if an error occurs..public void setMaxMemNonCompBlocks(int memSize) throws EssException
memSize
- The maximum memory reserved (in bytes).
EssException
- if an error occurs..public boolean isCalcNoAggMissing() throws EssException
EssException
- if an error occurs..public void setCalcNoAggMissing(boolean value) throws EssException
value
- true if missing values are not aggregated.
EssException
- if an error occurs..public boolean isCalcNoAvgMissing() throws EssException
EssException
- if an error occurs..public void setCalcNoAvgMissing(boolean value) throws EssException
value
- true if missing values are not included.
EssException
- if an error occurs..public boolean isCalcTwoPass() throws EssException
EssException
- if an error occurs..public void setCalcTwoPass(boolean twoPass) throws EssException
twoPass
- true if two pass calculation is enabled.
EssException
- if an error occurs..public boolean isDataCompress() throws EssException
EssException
- if an error occurs..public void setDataCompress(boolean dataCompress) throws EssException
dataCompress
- true if compression is enabled.
EssException
- if an error occurs..public boolean isCalcCreateBlock() throws EssException
EssException
- if an error occurs..public void setCalcCreateBlock(boolean value) throws EssException
value
- true, if blocks are forcibly created.
EssException
- if an error occurs..public java.lang.String getCurrencyCubeName() throws EssException
EssException
- if an error occurs..public void setCurrencyCubeName(java.lang.String dbName) throws EssException
dbName
- The currency cube name.
EssException
- if an error occurs..public java.lang.String getCurrencyConvTypeMemberName() throws EssException
EssException
- if an error occurs..public void setCurrencyConvTypeMemberName(java.lang.String mbrName) throws EssException
mbrName
- The currency conversion type member name.
EssException
- if an error occurs..public IEssCube.EEssCurrencyConversionType getCurrencyConvType() throws EssException
EssException
- if an error occurs..public void setCurrencyConvType(IEssCube.EEssCurrencyConversionType convType) throws EssException
convType
- The currency conversion type.
EssException
- if an error occurs..public int getIndexPageSize() throws EssException
EssException
- if an error occurs..public void setIndexPageSize(int size) throws EssException
size
- The size of the index page (in bytes).
EssException
- if an error occurs..public int getIndexCacheSize() throws EssException
EssException
- if an error occurs..public int getDefaultAccessLevel() throws EssException
EssException
- if an error occurs.public void setDefaultAccessLevel(int accessLevel) throws EssException
accessLevel
- The default access level. Combination of valules
from IEssCube.ESS_PRIV_* / IEssCube.ESS_ACCESS_*.
EssException
- if an error occurs.public java.lang.String getApplicationName() throws EssException
EssException
- if an error occurs.public IEssCube.EEssCubeType getCubeType() throws EssException
EssException
- if an error occurs..public IEssCube.EEssLoadStatus getCubeLoadStatus() throws EssException
EssException
- if an error occurs.public int getCountUsersConnected() throws EssException
EssException
- if an error occurs.public int getCountLocks() throws EssException
EssException
- if an error occurs.public int getCountDimensions() throws EssException
EssException
- if an error occurs.public IEssCube.EEssDataLoadStatus getDataLoadStatus() throws EssException
EssException
- if an error occurs.public int getElapsedCubeTime() throws EssException
EssException
- if an error occurs.public java.lang.String getCurrencyCountryMemberName() throws EssException
EssException
- if an error occurs.public java.lang.String getCurrencyTimeMemberName() throws EssException
EssException
- if an error occurs.public java.lang.String getCurrencyCategoryMemberName() throws EssException
EssException
- if an error occurs.public java.lang.String getCurrencyPartitionMemberName() throws EssException
EssException
- if an error occurs.public java.lang.String getCurrencyTypeMemberName() throws EssException
EssException
- if an error occurs.public int getDataCacheSize() throws EssException
EssException
- if an error occurs.public int getDeclaredBlockSize() throws EssException
EssException
- if an error occurs.public int getActualBlockSize() throws EssException
EssException
- if an error occurs.public double getDeclaredMaxBlocks() throws EssException
EssException
- if an error occurs.public double getActualMaxBlocks() throws EssException
EssException
- if an error occurs.public double getNonMissingLeafBlocks() throws EssException
EssException
- if an error occurs.public double getPagedOutBlocks() throws EssException
EssException
- if an error occurs.public double getPagedInBlocks() throws EssException
EssException
- if an error occurs.public double getTotalBlocks() throws EssException
EssException
- if an error occurs.public double getNonExclusiveLockCount() throws EssException
EssException
- if an error occurs.public double getExclusiveLockCount() throws EssException
EssException
- if an error occurs.public double getTotMemPagedInBlocks() throws EssException
EssException
- if an error occurs.public double getTotMemBlocks() throws EssException
EssException
- if an error occurs.public double getTotMemIndex() throws EssException
EssException
- if an error occurs.public double getNonMissingNonLeafBlocks() throws EssException
EssException
- if an error occurs.public double getBlockDensity() throws EssException
EssException
- if an error occurs.public double getSparseDensity() throws EssException
EssException
- if an error occurs.public double getCompressionRatio() throws EssException
EssException
- if an error occurs.public double getInMemCompBlocks() throws EssException
EssException
- if an error occurs.public double getTotMemInMemCompBlocks() throws EssException
EssException
- if an error occurs.public void refreshPropertyValues() throws EssException
refreshPropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void updatePropertyValues() throws EssException
updatePropertyValues
in interface IEssProperties
EssException
- if an error occurs.public IEssIterator getLocks() throws EssException
EssException
- if an error occurs.public IEssCubeOutline getOutline() throws EssException
EssException
- if an error occurs.public IEssCubeOutline openOutline() throws EssException
EssException
- if an error occurs.public IEssCubeOutline openOutline(boolean readOnly, boolean lock, boolean keepTrans) throws EssException
readOnly
- true to open the outline in read-only mode. false to
open the outline in read-write mode.lock
- true if the outline should be locked when it is opened in any
mode.keepTrans
- true to keep transactions. If you are opening an
existing outline to make changes (readOnly == false), and you intend to
restructure the cube and keep data, we recommend that you set this flag
to true. When true, a log is kept of activities done to the outline. If
you are starting from an empty outline or are not planning on saving data
when you restructure, we recommend that you set this field to false. When
false, no log is kept, saving time and memory.
EssException
- if an error occurs.public IEssMemberSelection openMemberSelection(java.lang.String name) throws EssException
name
- The name for the member selection.
EssException
- if an error occurs.public IEssMemberSelection openMemberSelection(java.lang.String name, boolean queryOverCache) throws EssException
name
- The name for the member selection.queryOverCache
- true to query over EDS outline cache.
EssException
- if an error occurs.public IEssCube copy(java.lang.String newCubeName, IEssOlapApplication destApp) throws EssException
destApp
- The destination application to copy to.
EssException
- if an error occurs.public void delete() throws EssException
EssException
- if an error occurs.public void rename(java.lang.String newCubeName) throws EssException
EssException
- if an error occurs.public IEssOlapApplication getApplication() throws EssException
EssException
- if an error occurs.public IEssCubeView openCubeView(java.lang.String name) throws EssException
name
- The cube view name.
EssException
- if an error occurs.public IEssCubeView openCubeView(java.lang.String name, boolean useConnPool, boolean connPerOp, boolean useCluster, boolean readOnly) throws EssException
name
- The cube view name.useConnPool
- true to use connection pool if available.connPerOp
- true for connection per operation. false for connection
per session.useCluster
- true to use cluster if available.readOnly
- true if to open in read only mode.
EssException
- if an error occurs.public IEssIterator getOpenCubeViews() throws EssException
EssException
- if an error occurs..public java.lang.String report(java.lang.String reportSpec, boolean output, boolean lockForUpdate) throws EssException
reportSpec
- The report script as a single string.output
- If true, data is output from the server, according to the
specified report. If false, no data is output.lockForUpdate
- If true, all blocks which are accessed by the
report specification are locked for update. If false, no blocks are
locked.
EssException
- if an error occurs.public java.lang.String report(boolean output, boolean lockForUpdate, java.lang.String reportFileName, boolean isLocalFile) throws EssException
output
- If true, data is output from the server, according to the
specified report. If false, no data is output.lockForUpdate
- If true, all blocks which are accessed by the
report specification are locked for update. If false, no blocks are
locked.reportFileName
- The name of the report specification file. Specify
the full path name for local file. Specify just the file name without the
extension for server based files.isLocalFile
- true if the file is located in the JAPI client machine.
false if the file is located in the olap server database directory.
EssException
- if an error occurs.public IEssSequentialIterator report(java.lang.String reportSpecOrFileName, boolean isFileName, boolean isLocalFile, boolean output, boolean lockForUpdate) throws EssException
reportSpecOrFileName
- The report script as a single string or a
file name holding the report.isFileName
- true if the reportSpecOrFileName parameter contains
a file name. false if it contains the report specification itself.isLocalFile
- true if the file is located in the JAPI client machine.
false if the file is located in the olap server database directory.output
- If true, data is output from the server, according to the
specified report. If false, no data is output.lockForUpdate
- If true, all blocks which are accessed by the
report specification are locked for update. If false, no blocks are
locked.
EssException
- if an error occurs.public void calculate(java.lang.String calcScript, boolean syntaxCheckOnly) throws EssException
calcScript
- The calc script as a single string.syntaxCheckOnly
- true if to perform syntax check only.
EssException
- if an error occurs.public void calculate() throws EssException
EssException
- if an error occurs.public void calculate(boolean syntaxCheckOnly, java.lang.String calcFileNamePrefix) throws EssException
syntaxCheckOnly
- true if to perform syntax check only.calcFileNamePrefix
- The calc script file name's prefix. This file
should be located in the olap server's application/cube directory, with
extension '.csc'. For eq, if the file name is calcall.csc, you should
pass "calcall" to this param.
EssException
- if an error occurs.public java.lang.String[] getAliasTableNames() throws EssException
EssException
- if an error occurs.public void loadAliasTable(java.lang.String aliasTableName, java.lang.String fileName) throws EssException
aliasTableName
- The name of the alias table to load.fileName
- The full path name of the structured alias names file on
the server.
EssException
- if an error occurs.public java.lang.String getAliasTableName() throws EssException
EssException
- if an error occurs.public void setAliasTableName(java.lang.String aliasTableName) throws EssException
EssException
- if an error occurs.public java.lang.String[][] getAliasTableEntries(java.lang.String aliasTableName) throws EssException
EssException
- if an error occurs.public void deleteAliasTable(java.lang.String aliasTableName) throws EssException
aliasTableName
- The name of the alias table to remove.
EssException
- if an error occurs.public void deleteAllAliasTables() throws EssException
EssException
- if an error occurs.public boolean isActive() throws EssException
EssException
- if an error occurs.public void setActive() throws EssException
EssException
- if an error occurs.public void clearActive() throws EssException
EssException
- if an error occurs.public void clearAllData() throws EssException
EssException
- if an error occurs.public void validateCube(java.lang.String errLogFileName) throws EssException
errLogFileName
- Error log file name, to be placed in the app\cube
directory in the olap server.
EssException
- if an error occurs.public void start() throws EssException
EssException
- if an error occurs.public void stop() throws EssException
EssException
- if an error occurs.public java.lang.String getNoteOfTheDay() throws EssException
EssException
- if an error occurs.public void setNoteOfTheDay(java.lang.String note) throws EssException
note
- The note-of-the-day message.
EssException
- if an error occurs.public java.lang.String getDefaultCalcScript() throws EssException
EssException
- if an error occurs.public void setDefaultCalcScript(boolean isFileName, java.lang.String defCalcScriptOrFile) throws EssException
isFileName
- true if defCalcScriptOrFile is a file name, false if
defCalcScriptOrFile is the calc script.defCalcScriptOrFile
- The default calc script or the file that
contains calc script.
EssException
- if an error occurs.public java.lang.String queryMembers(java.lang.String mbrQuery) throws EssException
mbrQuery
- The member query string. A query string is a command
similar to a report specification.
EssException
- if an error occurs.public boolean isValidMember(java.lang.String mbrName) throws EssException
mbrName
- The member name to be verified.
EssException
- if an error occurs.public IEssMember getMember(java.lang.String mbrName) throws EssException
mbrName
- The member name.
EssException
- if an error occurs.public java.lang.String[] getMemberCalc(java.lang.String mbrName) throws EssException
EssException
- if an error occurs.public IEssDimension getDimension(java.lang.String dimName) throws EssException
dimName
- The dimension name.
EssException
- if an error occurs.public IEssIterator getDimensions() throws EssException
EssException
- if an error occurs.public void buildDimension(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String errOutFile) throws EssException
rulesFileName
- The rules file name.rulesFileType
- The rules file type (IEssOlapFileObject.TYPE_*).dataFileName
- The data file name.dataFileType
- The data file type (IEssOlapFileObject.TYPE_*).errOutFile
- The error output file name.
EssException
- if an error occurs.public IEssIterator getOlapFileObjects(int objType) throws EssException
objType
- The object types. Values from IEssOlapFileObject.TYPE_*.
EssException
- if an error occurs.public IEssOlapFileObject getOlapFileObject(int objType, java.lang.String objName) throws EssException
objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void copyOlapFileObjectFromServer(int objType, java.lang.String objName, java.lang.String clientFileName, boolean lock) throws EssException
objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.clientFileName
- The full path of destination file in the client.lock
- Flag to control object locking. If true, the server object
is locked to prevent updates by other users.
EssException
- if an error occurs.public void copyOlapFileObjectToServer(int objType, java.lang.String objName, java.lang.String clientFileName, boolean unlock) throws EssException
objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.clientFileName
- The full path of source file in the client.
EssException
- if an error occurs.public void lockOlapFileObject(int objType, java.lang.String objName) throws EssException
objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void unlockOlapFileObject(int objType, java.lang.String objName) throws EssException
objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void createOlapFileObject(int objType, java.lang.String objName) throws EssException
objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void deleteOlapFileObject(int objType, java.lang.String objName) throws EssException
objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void renameOlapFileObject(int objType, java.lang.String objName, java.lang.String newObjName) throws EssException
objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void copyOlapFileObject(int objType, java.lang.String objName, java.lang.String destAppName, java.lang.String destCubeName, java.lang.String destObjName) throws EssException
objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.destAppName
- The destination application name.destCubeName
- The destination cube name.destObjName
- The destination object name.
EssException
- if an error occurs.public void archiveBegin(java.lang.String archFileName) throws EssException
archFileName
- The name of the file to contain archive information.
This file will be created in the olap server's application/cube
directory. For eg, if you invoke as archiveBegin("archfile"), a file
named archfile will be created in the directory mentioned above.
EssException
- if an error occurs.public void archiveEnd() throws EssException
EssException
- if an error occurs.public void exportData(java.lang.String fileName, IEssCube.EEssDataLevel dataLevel, boolean columns) throws EssException
fileName
- The name of the server file to contain the exported
information.columns
- Controls output of data blocks in column format (for
creating rules files).
EssException
- if an error occurs.public void exportData(java.lang.String fileName, IEssCube.EEssDataLevel dataLevel, short columns) throws EssException
EssException
public java.lang.String[][] loadData(java.lang.String updateSpecs, int rulesObjType, java.lang.String rulesFileName, boolean syntaxCheckOnly, boolean unlockAfterUpdate, boolean abortOnError) throws EssException
updateSpecs
- The update specification string. For eq: "Product Jan
Sales Actual Market 4444\n Product Feb Sales Actual Market 5555".rulesObjType
- The rules file object type. Values from
IEssOlapFileObject.TYPE_*.rulesFileName
- The rules file name in the olap server. For eg, for
the rules file named Data.rul in olap server's app/cube directory pass
"Data". This parameter can be null for Essbase OLAP server versions
6.5.1 and after, but not before (as there is a known bug that it hangs).syntaxCheckOnly
- true, if syntax check only. false, to store data.unlockAfterUpdate
- true to unlock blocks after the update.abortOnError
- If true, data load stops on the first error.
Otherwise, data load continues.
EssException
- if an error occurs.public void loadData(int rulesObjType, java.lang.String rulesFileName, int dataObjType, java.lang.String dataFileName, boolean abortOnError) throws EssException
rulesObjType
- The rules file object type. Values from
IEssOlapFileObject.TYPE_*.rulesFileName
- The rules file name in the olap server. For eg, for
the rules file named Data.rul in olap server's app/cube directory pass
"Data".dataObjType
- The data file object type. Values from
IEssOlapFileObject.TYPE_*.dataFileName
- The data file name in the olap server's app/cube
directory. For eg, for the file named data.txt in olap server's app/cube
directory pass "Data".abortOnError
- If true import stops on the first error otherwise
continues.
EssException
- if an error occurs.public void loadData(boolean store, boolean unlock, java.lang.String updSpec) throws EssException
store
- Controls storage of data. If true data is stored in the
server; if false no data is stored.unlock
- Controls unlocking of data blocks. If true all relevant
blocks which are locked will be unlocked (after data is stored,
if necessary). If false no blocks are unlocked.updSpec
- The update specification as a single string.
EssException
- if an error occurs.public IEssCube.EEssCubeAccess getUserOrGroupAccess(java.lang.String userOrGroupName) throws EssException
EssException
- if an error occurs.public void setUserOrGroupAccess(java.lang.String userOrGroupName, IEssCube.EEssCubeAccess access) throws EssException
access
- The cube access.
EssException
- if an error occurs.public IEssCube.IEssSecurityFilter createSecurityFilter(java.lang.String filterName) throws EssException
filterName
- The filter name.
EssException
- if an error occurs.public void deleteSecurityFilter(java.lang.String filterName) throws EssException
filterName
- The filter name.
EssException
- if an error occurs.public IEssCube.IEssSecurityFilter getSecurityFilter(java.lang.String filterName) throws EssException
filterName
- The filter name.
EssException
- if an error occurs.public IEssIterator getSecurityFilters() throws EssException
EssException
- if an error occurs.public java.lang.String getPerformanceStatistics() throws EssException
EssException
- if an error occurs.public void resetPerformanceStatisticsTables(int persistence, int scope) throws EssException
persistence
- One of the following values indicating the
persistence of the set of tables to be reset: 0: Reset short term tables
only, 1: Reset short and medium term tables, 2: Reset short, medium and
long term tables, 3: Disable performance statistics gathering, 4: Enable
performance statistics gathering.scope
- One of the following values indicating the scope of the set
of tables to be reset: 1: Reset thread-based tables only, 2: Reset
cube-based tables only, 4: Reset server-based tables only, 7: Reset all
tables.
EssException
- if an error occurs.public void createLocationAlias(java.lang.String aliasName, java.lang.String hostName, java.lang.String appName, java.lang.String cubeName, java.lang.String userName, java.lang.String password) throws EssException
aliasName
- The location alias name.hostName
- The target host.appName
- The target application name.cubeName
- The target cube name.userName
- The user name.password
- The user password.
EssException
- if an error occurs.public void deleteLocationAlias(java.lang.String aliasName) throws EssException
aliasName
- The location alias name.
EssException
- if an error occurs.public java.lang.String[][] getLocationAliases() throws EssException
EssException
- if an error occurs.public java.lang.String[][] getAssociatedAttributes(java.lang.String baseMbrName, java.lang.String attrDimName) throws EssException
baseMbrName
- The base member name.attrDimName
- The attribute dimension name (optional).
EssException
- if an error occurs.public void setSpanRelationalSource(boolean span) throws EssException
span
- true to span to relational source.
EssException
- if an error occurs.public boolean isSpanRelationalSource() throws EssException
EssException
- if an error occurs.public boolean verifyFormula(java.lang.String formulaName) throws EssException
formulaName
- The name of the formula.
EssException
- if an error occurs.public java.lang.String getCalcFunctions() throws EssException
EssException
- if an error occurs.public void createCDF(java.lang.String appName, java.lang.String name, java.lang.String javaSpec, int options, java.lang.String spec, java.lang.String comment) throws EssException
EssException
public void deleteCDF(java.lang.String appName, java.lang.String name) throws EssException
EssException
public void createCDM(java.lang.String appName, java.lang.String name, java.lang.String definition, java.lang.String signature, java.lang.String spec, java.lang.String comment) throws EssException
EssException
public void deleteCDM(java.lang.String appName, java.lang.String name) throws EssException
EssException
public java.lang.String[][] getCDM_CDF(java.lang.String appName) throws EssException
EssException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |