|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IEssCube
The IEssCube is the olap cube.
| Nested Class Summary | |
|---|---|
static class |
IEssCube.EEssCubeAccessThe EEssCubeAccess is an enumeration of cube access levels. |
static class |
IEssCube.EEssCubeletType |
static class |
IEssCube.EEssCubeTypeThe EEssCubeType class. |
static class |
IEssCube.EEssCurrencyConversionTypeThe EEssCurrencyConversionType class. |
static class |
IEssCube.EEssDataLevelThe EEssDataLevel class is an enumeration of data level on export. |
static class |
IEssCube.EEssDataLoadStatusThe EEssDataLoadStatus class. |
static class |
IEssCube.EEssLoadStatusThe EEssLoadStatus class is an enumeration of Cube load status. |
static class |
IEssCube.EEssRestructureOptionThe EEssRestructureOption class is an enumeration of Cube restructure options. |
static class |
IEssCube.EEssTimePeriodEEssTimePeriod class represents a time period. |
static interface |
IEssCube.IEssCubeLockThe IEssCubeLock interface provides information about the data blocks exclusively locked. |
static interface |
IEssCube.IEssSecurityFilterThe IEssSecurityFilter is cube security filter. |
| Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties |
|---|
IEssProperties.EEssPropertyMode |
| Nested classes/interfaces inherited from interface 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 |
archiveDatabase(java.lang.String backupFileName, java.lang.String optionsFileName, boolean overWrite)Archives the current database to the file specified. |
void |
archiveEnd()After archive, returns cube status to read-write. |
void |
asyncBuildDimension(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String userName, java.lang.String password, int buildDimOptions, java.lang.String tmpOtlFileName)Asyncronously loads data in to a Cube. |
void |
asyncLoadData(int rulesObjType, java.lang.String rulesFileName, int dataObjType, java.lang.String dataFileName, boolean abortOnError, java.lang.String userName, java.lang.String password)Allows the importing of data from text files to this cube. |
void |
asyncLoadData(int rulesFileType, java.lang.String rulesFileName, int dataFileType, java.lang.String dataFileName, boolean abortOnError, java.lang.String userName, java.lang.String password, int bufferId)Allows the importing of data from text files to this ASO cube. |
void |
beginDataload(boolean Store, boolean Unlock, boolean AbortOnError, java.lang.String rulesFileName, int rulesObjectType)Starts sending an update specification to the active database, and can unlock any data blocks locked for update. |
void |
beginDataload(boolean Store, boolean Unlock, boolean AbortOnError, java.lang.String rulesFileName, int rulesObjectType, int bufferId)Starts sending an update specification to the active database, and can unlock any data blocks locked for update. |
java.lang.String[][] |
beginDataload(java.lang.String rulesFileName, int rulesObjectType, java.lang.String dataFileName, int dataFileType, boolean AbortOnError, int bufferId)Imports from a data file. |
java.lang.String[][] |
beginDataload(java.lang.String rulesFileName, int rulesObjectType, java.lang.String dataFileName, int dataFileType, java.lang.String userName, java.lang.String password, boolean AbortOnError, int bufferId)Imports the data for ASO from FTP and SQL source. |
java.lang.String[][] |
beginDataload(java.lang.String rulesFileName, int rulesObjectType, java.lang.String userName, java.lang.String password, boolean AbortOnError, int bufferId)Imports the data from SQL source. |
IEssCubeOutline |
beginIncrementalBuildDim()Gives an instruction to the Cube that incremental Dimension build is started. |
void |
beginStreamBuildDim(java.lang.String rulesFileName, int rulesFileType, int incBuildOption, java.lang.String tmpOtlFilename)Begins the Streaming Dimension build on this Cube. |
void |
beginUpdate(boolean store, boolean unlock)Starts sending an update specification to the active database. |
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 |
buildDimensionFile(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String errOutFile, boolean overwriteErrFile)Builds a data file used to add or remove members from the active cube outline. |
void |
buildDimensionStart()This starts the process to add or remove members from the active database outline. |
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. |
java.lang.StringBuffer |
cancelAsyncProcess(java.lang.String ErrorFileName, boolean overwrite, boolean addToBuffer)Cancels the async process. |
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. |
void |
clearPartialData(java.lang.String regionSpec, boolean isPhysical)Clears data from a specific region(slice) of an ASO Database. |
com.essbase.api.datasource.EssBuildDimDataLoadState |
closeAsyncProcess()closes the async process and returns the current state of the process Note : This API must follow the call of either unsynchronized dimension build API or unsynchronized data load API. |
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. |
byte[] |
copyOlapFileObjectFromServer(int objType, java.lang.String objName, boolean lock)Copies an object from the olap server to a byte sequence and optionally locks the server object to prevent updates by others. |
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, byte[] content, boolean unlock)Copies an object in the form of byte sequence to the olap server, and optionally unlocks the server object to allow 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)Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication. |
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)Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication. |
void |
createDrillThroughURL(java.lang.String URLName, boolean bIsLevel0, java.lang.String URLLink, java.lang.String[] drillRegions). |
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. |
void |
createReferenceCube(java.lang.String locAlias, IEssCube.EEssCubeletType clType, long limit)creates a reference cube. |
IEssCube.IEssSecurityFilter |
createSecurityFilter(java.lang.String filterName)Creates an security filter with empty filter rows. |
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)Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication. |
void |
deleteCDM(java.lang.String appName, java.lang.String name)Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication. |
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. |
java.lang.String[][] |
endDataload()marks the end of an update specification being sent to the active database, and must be called after sending the update specification using EssSendString(). |
java.lang.StringBuffer |
endIncrementalBuildDim(short RestructOption, java.lang.String tmpOtlFilename, java.lang.String ErrorFileName)Ends the Incremental Dimension build. |
java.lang.StringBuffer |
endIncrementalBuildDim(short RestructOption, java.lang.String tmpOtlFilename, java.lang.String ErrorFileName, boolean addToBuffer)Ends the Incremental Dimension build. |
java.lang.StringBuffer |
endStreamBuildDim(java.lang.String ErrorFileName)Completes the Streaming Dimension build on this Cube. |
java.lang.StringBuffer |
endStreamBuildDim(java.lang.String ErrorFileName, boolean addToBuffer)Completes the Streaming Dimension build on this Cube. |
void |
endUpdate()Marks the end of an update specification being sent to the active database. |
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. |
java.lang.StringBuffer |
getAsyncProcessLog(java.lang.String ErrorFileName, boolean overwrite, boolean addToBuffer)Gets the async process log. |
com.essbase.api.datasource.EssBuildDimDataLoadState |
getAsyncProcessState()Gets the async process state. |
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)Deprecated. This Method has been moved to IEssOlapServer and IEssOlapApplication. |
java.lang.String[] |
getCellDrillThroughReports(java.lang.String[] pMembers)Gets the drill through reports associated for the specified member combination as an array of XMLs. |
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. |
IEssURLDrillThrough |
getDrillThroughURL(java.lang.String URLName)Get the drill through URL within this database outline with specified URLName. |
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. |
IEssPerformAllocation |
getPerformAllocationInstance()Gets an IEssPerformAllcation instance using which Allocations can be performed. |
java.lang.String |
getPerformanceStatistics()Gets the performance statistics. |
IEssPerformCustomCalc |
getPerformCustomCalcInstance()Gets an IEssPerformCustomCalc instance using which Custom Calculations can be performed. |
IEssCube.IEssSecurityFilter |
getSecurityFilter(java.lang.String filterName)Starts getting the contents of a filter. |
IEssIterator |
getSecurityFilters()Gets all the security filters for a database. |
IEssIterator |
getSecurityFiltersWithNameOnly()Gets all the security filters for a database only with the filter name initially. |
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. |
java.lang.String |
getUMCData()Retrieves the Universal Member CommentEx. |
IEssCube.EEssCubeAccess |
getUserOrGroupAccess(java.lang.String userOrGroupName)Gets the user or group access for this cube. |
java.lang.StringBuffer |
incrementalBuildDim(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String userName, java.lang.String password, int incBuildOption, java.lang.String tmpOtlFilename, java.lang.String ErrorFileName)Performs the Dimension build and/or Data load using the specified rule and data files. |
java.lang.StringBuffer |
incrementalBuildDim(java.lang.String rulesFileName, int rulesFileType, java.lang.String dataFileName, int dataFileType, java.lang.String userName, java.lang.String password, int incBuildOption, java.lang.String tmpOtlFilename, java.lang.String ErrorFileName, boolean addToBuffer)Performs the Dimension build and/or Data load using the specified rule and data files. |
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. |
IEssURLDrillThrough[] |
listDrillThroughURLs()Lists the drill through URLs within this database. |
com.essbase.api.datasource.EssLOADBUFFER[] |
listExistingLoadBuffers()Lists existing load buffers. |
IEssReferenceCubeInfo[] |
listReferenceCubes()returns a list of reference cubes on the target, which includes a status for each reference cube (valid or invalid, loaded or unloaded). |
com.essbase.api.datasource.EssTRANSACTION[] |
listTransactions(short startTimeSrc, java.lang.String startTime, short listOption, java.lang.String fileName)EssListTransactions() sends a request for listing transactions happened after certain time to server and retrieves an array of transaction list as requested. |
void |
loadAliasTable(java.lang.String aliasTableName, java.lang.String fileName)Loads an alias table for the active database from a structured text file. |
void |
loadBufferInit(long bufferId, long duplicateAggregationMethod, long options, long size)Creates ASO load buffer with specified ID. |
void |
loadBufferTerm(long[] bufferId, long commitType, long actionType, long options)Stores the loaded buffers. |
void |
loadData(boolean store, boolean unlock, java.lang.String updSpec)Updates data to cube from the specification string. |
java.lang.String[][] |
loadData(int rulesObjType, java.lang.String rulesFileName, int dataObjType, java.lang.String dataFileName, boolean abortOnError)Allows the importing of data from external data sources to this cube.The rule and data files can exist either on the server or the client file-system. |
java.lang.String[][] |
loadData(int rulesObjType, java.lang.String rulesFileName, int dataObjType, java.lang.String dataFileName, boolean abortOnError, java.lang.String userName, java.lang.String password)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. |
java.lang.String[][] |
loadDataEx(boolean store, boolean unlock, java.lang.String updSpec)Updates data to cube from the specification string. |
void |
loadReferenceCube(java.lang.String locAlias)retrieves reference cube values, placing them in target memory. |
void |
lockOlapFileObject(int objType, java.lang.String objName)Locks an object on the server to prevent other users from updating it. |
void |
mergeDatabaseData(long options)Merges ASO database data. |
IEssCubeView |
openCubeView(java.lang.String name)Opens a cube view. |
IEssCubeView |
openCubeView(java.lang.String name, boolean useConnPool, boolean connPerOp, boolean useCluster, boolean readOnly)Deprecated. Use the other openCubeView method. |
IEssMemberSelection |
openMemberSelection(boolean usePool, boolean useCluster, java.lang.String connPoolOrClusterName, java.lang.String name)Deprecated. This method is deprecated. This method will work in cluster mode automatically based on whether the cube is connected to a cluster. |
IEssMemberSelection |
openMemberSelection(java.lang.String name)Opens a member selection. |
IEssMemberSelection |
openMemberSelection(java.lang.String name, boolean queryOverCache)Deprecated. This method is deprecated. QueryOverCache feature is no longer supported. |
IEssCubeOutline |
openOutline()Opens the cube outline in read-only mode. |
IEssCubeOutline |
openOutline(boolean dimBldOtl) |
IEssCubeOutline |
openOutline(boolean readOnly, boolean lock, boolean keepTrans)Opens the cube outline in read-only or read-write mode. |
IEssCubeOutline |
openOutline(boolean readOnly, boolean lock, boolean keepTrans, boolean incremental)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 |
removeReferenceCube(java.lang.String locAlias)deletes a reference cube. |
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. |
void |
replayTransactions(com.essbase.api.datasource.EssTRANSACTION_REPLAY replayTran, com.essbase.api.datasource.EssSEQID[] seqIds)Sends a request to replay transactions happened after certain time to agent. |
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 |
restoreDatabase(java.lang.String backupFileName, boolean forceDiffName, java.lang.String[] Src_Partitions, java.lang.String[] Dest_Partitions)Restores the database with the data from the specified backup file. |
void |
restructure(short restructOption)Restructures the outline on the server. |
void |
sendString(java.lang.String str)Sends a string of data to the active database. |
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 loadable)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. |
IEssCube.IEssSecurityFilter |
setSecurityFilter(java.lang.String filterName, boolean Active, IEssCube.EEssCubeAccess Access)Creates or replaces a filter, and starts setting the contents of the filter. |
void |
setSecurityFilterList(IEssCube.IEssSecurityFilter filter, java.lang.String[] usersAndOrGroups)Sets the list of groups and/or users that are assigned to a filter. |
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 |
setUMCData(java.lang.String UMC)Sets the Universal Member CommentEx to the outline without having to restructure the outline. |
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 |
unloadReferenceCube(java.lang.String locAlias)removes reference cube values from target memory. |
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. |
boolean |
verifyMDXExpression(java.lang.String mdxExpression, long exprType, java.util.List outErrorsIfAny)Validates the MDX expression based on its type, against this cube. |
| 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 |
|---|
static final int PROP_NAME
static final int PROP_DESCRIPTION
static final int PROP_IS_LODABLE
static final int PROP_IS_AUTOLOAD
static final int PROP_CUBE_ACCESS
static final int PROP_MAX_MEM_NON_COMP_BLOCKS
static final int PROP_IS_CALC_NO_AGG_MISSING
static final int PROP_IS_CALC_NO_AVG_MISSING
static final int PROP_IS_CALC_TWO_PASS
static final int PROP_DATA_COMPRESS
static final int PROP_CALC_CREATE_BLOCK
static final int PROP_CURRENCY_CUBE_NAME
static final int PROP_CURRENCY_CONV_TYPE_MEMBER_NAME
static final int PROP_CURRENCY_CONV_TYPE
static final int PROP_INDEX_PAGE_SIZE
static final int PROP_INDEX_CACHE_SIZE
static final int PROP_APPLICATION_NAME
static final int PROP_CUBE_TYPE
static final int PROP_CUBE_LOAD_STATUS
static final int PROP_COUNT_OF_USERS_CONNECTED
static final int PROP_COUNT_OF_LOCKS
static final int PROP_COUNT_OF_DIMENSIONS
static final int PROP_DATA_LOAD_STATUS
static final int PROP_ELAPSED_CUBE_TIME
static final int PROP_CURRENCY_COUNTRY_MEMBER
static final int PROP_CURRENCY_TIME_MEMBER
static final int PROP_CURRENCY_CATEGORY_MEMBER
static final int PROP_CURRENCY_PARTITION_MEMBER
static final int PROP_CURRENCY_TYPE_MEMBER
static final int PROP_DATA_CACHE_SIZE
static final int PROP_DECLARED_BLOCK_SIZE
static final int PROP_ACTUAL_BLOCK_SIZE
static final int PROP_DECLARED_MAX_BLOCKS
static final int PROP_ACTUAL_MAX_BLOCKS
static final int PROP_NON_MISSING_LEAF_BLOCKS
static final int PROP_PAGED_OUT_BLOCKS
static final int PROP_PAGED_IN_BLOCKS
static final int PROP_TOTAL_BLOCKS
static final int PROP_NON_EXCLUSIVE_LOCK_COUNT
static final int PROP_EXCLUSIVE_LOCK_COUNT
static final int PROP_TOTAL_MEMORY_PAGED_IN_BLOCKS
static final int PROP_TOTAL_MEMORY_ALL_BLOCKS
static final int PROP_TOTAL_MEMORY_FOR_INDEX
static final int PROP_COUNT_OF_NON_MISSING_NON_LEAF_BLOCKS
static final int PROP_BLOCK_DENSITY
static final int PROP_SPARSE_DENSITY
static final int PROP_COMPRESSION_RATIO
static final int PROP_COUNT_OF_INMEM_COMPRESSED_BLOCKS
static final int PROP_TOTAL_MEMORY_FOR_INMEM_COMPRESSED_BLOCKS
static final int PROP_DATA_CACHE_SETTING
static final int PROP_DATAFILE_CACHE_SIZE
static final int PROP_DATAFILE_CACHE_SETTING
static final int PROP_INDEX_CACHE_SETTING
static final int PROP_INDEX_PAGE_SETTING
static final int PROP_RETRIEVAL_BUFFER
static final int PROP_RETRIEVAL_SORT_BUFFER
static final int PROP_CACHE_MEMORY_LOCKING
static final int PROP_ISOLATION_LEVEL
static final int PROP_PRE_EMAGE
static final int PROP_COMMIT_BLOCKS
static final int PROP_COMMIT_ROWS
static final int PROP_DATA_COMPRESS_TYPE
static final int s_countProperties
static final java.lang.String[] s_propNames
static final IEssValueAny.EEssDataType[] s_propDataTypes
static final IEssProperties.EEssPropertyMode[] s_propModes
static final int ESS_INCDIMBUILD_BUILD
static final int ESS_INCDIMBUILD_VERIFY
static final int ESS_INCDIMBUILD_SAVEOTL
static final int ESS_INCDIMBUILD_ALL
static final short ESS_INCDIMBUILD_RESTRUCT_OPT1
static final short ESS_DOR_ALLDATA
static final short ESS_DOR_NODATA
static final short ESS_DOR_LOWDATA
static final short ESS_DOR_INDATA
static final short ESS_DOR_FORCE_ALLDATA
static final long ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD
static final long ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL
static final long ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST
static final long ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES
static final long ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES
static final long ESS_ASO_DATA_LOAD_BUFFER_STORE_DATA
static final long ESS_ASO_DATA_LOAD_BUFFER_ADD_DATA
static final long ESS_ASO_DATA_LOAD_BUFFER_SUBTRACT_DATA
static final long ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_ALL_DATA
static final long ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_INCREMENTAL_DATA
static final long ESS_ASO_DATA_LOAD_BUFFER_COMMIT
static final long ESS_ASO_DATA_LOAD_BUFFER_ABORT
static final long ESS_ASO_DATA_LOAD_INCR_TO_MAIN_SLICE
static final long ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE
static final long ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE_LIGHTWEIGHT
static final long ESS_ASO_DATA_LOAD_IN_USE_BIT_MASK
static final int ESS_UDF_FUNCTION_VECTOR
static final int ESS_UDF_FUNCTION_SINGLECELL
static final int ESS_UDF_FUNCTION_TRIGGER_FUNC
static final int ESS_UDF_FUNCTION_RUNTIME
static final short ESS_LIST_TRANSACTIONS_TOCLIENT
static final short ESS_LIST_TRANSACTIONS_TOFILE
static final short ESS_LIST_TRANSACTIONS_FORCETOFILE
static final long ESS_ASO_VERIFY_MEMBER_EXPR
static final long ESS_ASO_VERIFY_TUPLE_EXPR
static final long ESS_ASO_VERIFY_SET_EXPR
static final long ESS_ASO_VERIFY_NUMERIC_EXPR
static final short ESS_BLDDL_STATE_DONE
static final short ESS_BLDDL_STATE_INPROGRESS
static final short ESS_BLDDL_STATE_FINALSTAGE
static final short ESS_BLDDL_STAGE_NONE
static final short ESS_BLDDL_STAGE_OPENDATASOURCE
static final short ESS_BLDDL_STAGE_OPENOTL
static final short ESS_BLDDL_STAGE_BUILDOTL
static final short ESS_BLDDL_STAGE_VERIFYOTL
static final short ESS_BLDDL_STAGE_WRITEOTL
static final short ESS_BLDDL_STAGE_RESTRUCT
static final short ESS_BLDDL_STAGE_DATALOAD
static final short ESS_BLDDL_STAGE_FINALIZE
| Method Detail |
|---|
java.lang.String getName()
throws com.essbase.api.base.EssException
getName in interface IEssExtendedObjectcom.essbase.api.base.EssException - if an error occurs.
java.lang.String getDescription()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setDescription(java.lang.String desc)
throws com.essbase.api.base.EssException
desc - The cube description.com.essbase.api.base.EssException - if an error occurs..
boolean isLoadable()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setLoadable(boolean loadable)
throws com.essbase.api.base.EssException
loadable - true if the Cube is loadable.com.essbase.api.base.EssException - if an error occurs..
boolean isAutoLoad()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setAutoLoad(boolean autoLoad)
throws com.essbase.api.base.EssException
autoLoad - true if the Cube will be automatically loaded.com.essbase.api.base.EssException - if an error occurs..
IEssCube.EEssCubeAccess getCubeAccess()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.getUserOrGroupAccess(String)
void setCubeAccess(IEssCube.EEssCubeAccess access)
throws com.essbase.api.base.EssException
access - The cube access.com.essbase.api.base.EssException - if an error occurs.setUserOrGroupAccess(String, IEssCube.EEssCubeAccess)
int getMaxMemNonCompBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setMaxMemNonCompBlocks(int memSize)
throws com.essbase.api.base.EssException
memSize - The maximum memory reserved (in bytes).com.essbase.api.base.EssException - if an error occurs..
boolean isCalcNoAggMissing()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setCalcNoAggMissing(boolean value)
throws com.essbase.api.base.EssException
value - true if missing values are not aggregated.com.essbase.api.base.EssException - if an error occurs..
boolean isCalcNoAvgMissing()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setCalcNoAvgMissing(boolean value)
throws com.essbase.api.base.EssException
value - true if missing values are not included.com.essbase.api.base.EssException - if an error occurs..
boolean isCalcTwoPass()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setCalcTwoPass(boolean twoPass)
throws com.essbase.api.base.EssException
twoPass - true if two pass calculation is enabled.com.essbase.api.base.EssException - if an error occurs..
boolean isDataCompress()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setDataCompress(boolean dataCompress)
throws com.essbase.api.base.EssException
dataCompress - true if compression is enabled.com.essbase.api.base.EssException - if an error occurs..
boolean isCalcCreateBlock()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setCalcCreateBlock(boolean value)
throws com.essbase.api.base.EssException
value - true, if blocks are forcibly created.com.essbase.api.base.EssException - if an error occurs..
java.lang.String getCurrencyCubeName()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setCurrencyCubeName(java.lang.String dbName)
throws com.essbase.api.base.EssException
dbName - The currency cube name.com.essbase.api.base.EssException - if an error occurs..
java.lang.String getCurrencyConvTypeMemberName()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setCurrencyConvTypeMemberName(java.lang.String mbrName)
throws com.essbase.api.base.EssException
mbrName - The currency conversion type member name.com.essbase.api.base.EssException - if an error occurs..
IEssCube.EEssCurrencyConversionType getCurrencyConvType()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setCurrencyConvType(IEssCube.EEssCurrencyConversionType convType)
throws com.essbase.api.base.EssException
convType - The currency conversion type.com.essbase.api.base.EssException - if an error occurs..
int getIndexPageSize()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
void setIndexPageSize(int size)
throws com.essbase.api.base.EssException
size - The size of the index page (in bytes).com.essbase.api.base.EssException - if an error occurs..
int getIndexCacheSize()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
int getDefaultAccessLevel()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void setDefaultAccessLevel(int accessLevel)
throws com.essbase.api.base.EssException
accessLevel - The default access level. Combination of values from IEssCube.ESS_PRIV_* / IEssCube.ESS_ACCESS_*.com.essbase.api.base.EssException - if an error occurs.
java.lang.String getApplicationName()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
IEssCube.EEssCubeType getCubeType()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
IEssCube.EEssLoadStatus getCubeLoadStatus()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
int getCountUsersConnected()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
int getCountLocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
int getCountDimensions()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
IEssCube.EEssDataLoadStatus getDataLoadStatus()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
int getElapsedCubeTime()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
java.lang.String getCurrencyCountryMemberName()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
java.lang.String getCurrencyTimeMemberName()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
java.lang.String getCurrencyCategoryMemberName()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
java.lang.String getCurrencyPartitionMemberName()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
java.lang.String getCurrencyTypeMemberName()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
int getDataCacheSize()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
int getDeclaredBlockSize()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
int getActualBlockSize()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getDeclaredMaxBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getActualMaxBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getNonMissingLeafBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getPagedOutBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getPagedInBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getTotalBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getNonExclusiveLockCount()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getExclusiveLockCount()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getTotMemPagedInBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getTotMemBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getTotMemIndex()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getNonMissingNonLeafBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getBlockDensity()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getSparseDensity()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getCompressionRatio()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getInMemCompBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
double getTotMemInMemCompBlocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void refreshPropertyValues()
throws com.essbase.api.base.EssException
refreshPropertyValues in interface IEssPropertiescom.essbase.api.base.EssException - if an error occurs.
void updatePropertyValues()
throws com.essbase.api.base.EssException
updatePropertyValues in interface IEssPropertiescom.essbase.api.base.EssException - if an error occurs.
IEssIterator getLocks()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
IEssCubeOutline getOutline()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
IEssCubeOutline openOutline()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
IEssCubeOutline openOutline(boolean dimBldOtl)
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
IEssCubeOutline openOutline(boolean readOnly,
boolean lock,
boolean keepTrans)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
IEssCubeOutline openOutline(boolean readOnly,
boolean lock,
boolean keepTrans,
boolean incremental)
throws com.essbase.api.base.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.incremental - true if the outline should be opened in incremental mode.com.essbase.api.base.EssException - if an error occurs.
IEssMemberSelection openMemberSelection(java.lang.String name)
throws com.essbase.api.base.EssException
name - The name for the member selection.com.essbase.api.base.EssException - if an error occurs.
IEssMemberSelection openMemberSelection(boolean usePool,
boolean useCluster,
java.lang.String connPoolOrClusterName,
java.lang.String name)
throws com.essbase.api.base.EssException
usePool - true to use connection pool.useCluster - true to use cluster if available.connPoolOrClusterName - - connection pool or cluster name to use. If usePool is true, this parameter represents connection pool name, else this parameter represents cluster name. If this parameter is null, a connection pool or a cluster will be chosen, if available, based on the values of other parameters. If it is not null then it should be a valid active connection pool or cluster name.name - The name for the member selection.com.essbase.api.base.EssException - if an error occurs.
IEssMemberSelection openMemberSelection(java.lang.String name,
boolean queryOverCache)
throws com.essbase.api.base.EssException
name - The name for the member selection.queryOverCache - true to query over EDS outline cache.com.essbase.api.base.EssException - if an error occurs.
IEssCube copy(java.lang.String newCubeName,
IEssOlapApplication destApp)
throws com.essbase.api.base.EssException
newCubeName - The new cube name.destApp - The destination application to copy to.com.essbase.api.base.EssException - if an error occurs.
void delete()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void rename(java.lang.String newCubeName)
throws com.essbase.api.base.EssException
newCubeName - The new name for the Cube.com.essbase.api.base.EssException - if an error occurs.
IEssOlapApplication getApplication()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
IEssCubeView openCubeView(java.lang.String name)
throws com.essbase.api.base.EssException
name - The cube view name.com.essbase.api.base.EssException - if an error occurs.
IEssCubeView openCubeView(java.lang.String name,
boolean useConnPool,
boolean connPerOp,
boolean useCluster,
boolean readOnly)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
IEssIterator getOpenCubeViews()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs..
java.lang.String report(java.lang.String reportSpec,
boolean output,
boolean lockForUpdate)
throws com.essbase.api.base.EssException
String output = report("IDESC Year !", true, false);reportSpec - The report script as a single string. (must be less than 64 Kbytes)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.com.essbase.api.base.EssException - if an error occurs.
java.lang.String report(boolean output,
boolean lockForUpdate,
java.lang.String reportFileName,
boolean isLocalFile)
throws com.essbase.api.base.EssException
String output = report(true, false, "Top", false);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.com.essbase.api.base.EssException - if an error occurs.
IEssSequentialIterator report(java.lang.String reportSpecOrFileName,
boolean isFileName,
boolean isLocalFile,
boolean output,
boolean lockForUpdate)
throws com.essbase.api.base.EssException
IEssSequentialIterator output = report("Top", true, false, true, false);
String part = null;
while ((part = output.getNextString()) != null)
System.out.print(part);
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.com.essbase.api.base.EssException - if an error occurs.
void calculate(java.lang.String calcScript,
boolean syntaxCheckOnly)
throws com.essbase.api.base.EssException
calcScript - The calc script as a single string.syntaxCheckOnly - true if to perform syntax check only.com.essbase.api.base.EssException - if an error occurs.
void calculate()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void calculate(boolean syntaxCheckOnly,
java.lang.String calcFileNamePrefix)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
void beginUpdate(boolean store,
boolean unlock)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
void sendString(java.lang.String str)
throws com.essbase.api.base.EssException
str - Data string (must be less than 32 Kbytes in length.com.essbase.api.base.EssException - if an error occurs.
void endUpdate()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void beginDataload(boolean Store,
boolean Unlock,
boolean AbortOnError,
java.lang.String rulesFileName,
int rulesObjectType)
throws com.essbase.api.base.EssException
Store - - Controls storage of data. If TRUE, data is stored in the server; if FALSE, no data is storedUnlock - - 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. Note : Not supported for aggregate storage databases. In case of a ASO database, it needs be passed as FALSE.AbortOnError - - If TRUE, data load stops on the first error. Otherwise, data load continues.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).rulesObjectType - - The rules file object type. Values from IEssOlapFileObject.TYPE_*.com.essbase.api.base.EssException
java.lang.String[][] beginDataload(java.lang.String rulesFileName,
int rulesObjectType,
java.lang.String userName,
java.lang.String password,
boolean AbortOnError,
int bufferId)
throws com.essbase.api.base.EssException
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).rulesObjectType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.userName - - String, the SQL source username.password - - String, the SQL user's password.AbortOnError - If TRUE, data load stops on the first error. Otherwise, data load continues.bufferId - The Buffer Identifiercom.essbase.api.base.EssException
java.lang.String[][] beginDataload(java.lang.String rulesFileName,
int rulesObjectType,
java.lang.String dataFileName,
int dataFileType,
java.lang.String userName,
java.lang.String password,
boolean AbortOnError,
int bufferId)
throws com.essbase.api.base.EssException
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).rulesObjectType - - The rules file object type. Values from IEssOlapFileObject.TYPE_*.dataFileName - - String, for an FTP source, then ftp://host/folder/data.txt, null for SQL source.dataFileType - - int, the data file object type. Values from IEssOlapFileObject.TYPE_*.userName - - String, the SQL source/FTP username.password - - String, the SQL/FTP user's password.AbortOnError - If TRUE, data load stops on the first error. Otherwise, data load continues.bufferId - The Buffer Identifiercom.essbase.api.base.EssException
java.lang.String[][] beginDataload(java.lang.String rulesFileName,
int rulesObjectType,
java.lang.String dataFileName,
int dataFileType,
boolean AbortOnError,
int bufferId)
throws com.essbase.api.base.EssException
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).rulesObjectType - The rules 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".dataFileType - - The data file object type. Values from IEssOlapFileObject.TYPE_*.AbortOnError - If TRUE, data load stops on the first error. Otherwise, data load continues.bufferId - The Buffer Identifiercom.essbase.api.base.EssException
void beginDataload(boolean Store,
boolean Unlock,
boolean AbortOnError,
java.lang.String rulesFileName,
int rulesObjectType,
int bufferId)
throws com.essbase.api.base.EssException
Store - Controls storage of data. If TRUE, data is stored in the server; if FALSE, no data is storedUnlock - Not supported for aggregate storage databases. Always pass FALSE for this parameter.AbortOnError - If TRUE, data load stops on the first error. Otherwise, data load continues.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).rulesObjectType - The rules file object type. Values from IEssOlapFileObject.TYPE_*.bufferId - The Buffer Identifiercom.essbase.api.base.EssException
java.lang.String[][] endDataload()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
java.lang.String[] getAliasTableNames()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void loadAliasTable(java.lang.String aliasTableName,
java.lang.String fileName)
throws com.essbase.api.base.EssException
aliasTableName - The name of the alias table to load.fileName - The full path name of the structured alias names file on the server.com.essbase.api.base.EssException - if an error occurs.
java.lang.String getAliasTableName()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void setAliasTableName(java.lang.String aliasTableName)
throws com.essbase.api.base.EssException
aliasTableName - The name of the alias table to set active.com.essbase.api.base.EssException - if an error occurs.
java.lang.String[][] getAliasTableEntries(java.lang.String aliasTableName)
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void deleteAliasTable(java.lang.String aliasTableName)
throws com.essbase.api.base.EssException
aliasTableName - The name of the alias table to remove.com.essbase.api.base.EssException - if an error occurs.
void deleteAllAliasTables()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
boolean isActive()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void setActive()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void clearActive()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void clearAllData()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void validateCube(java.lang.String errLogFileName)
throws com.essbase.api.base.EssException
validateCube("errlog");errLogFileName - Error log file name, to be placed in the app\cube directory in the olap server.com.essbase.api.base.EssException - if an error occurs.
void start()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void stop()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
java.lang.String getNoteOfTheDay()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void setNoteOfTheDay(java.lang.String note)
throws com.essbase.api.base.EssException
note - The note-of-the-day message.com.essbase.api.base.EssException - if an error occurs.
java.lang.String getDefaultCalcScript()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void setDefaultCalcScript(boolean isFileName,
java.lang.String defCalcScriptOrFile)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
java.lang.String queryMembers(java.lang.String mbrQuery)
throws com.essbase.api.base.EssException
This function supports an attribute member long name. See the Technical Reference for descriptions of report specifications.
This function can return information on member stored as a relational partition if its enabled using IEssCube.setSpanRelationalSource.
This function supports sorting of members based on member names, aliases (which are the same as member names for relational members) and dimension/generation numbers. For other options, the relational members are treated identically and displayed at the end of the list of members.
Not all member selection strings are supported in the relational store. This function can return relational information on the following member selection strings:
The Member query string consists of a selection string and an optional sorting command followed by an optional output command. The form is:
mbrQuery ==: <selectionstring> [<sortcommand> [<outputcommand>] ]The valid values for member <selectionstring> are:
<CHILDRENOF <ALLINSAMEDIM <DIMTOP <OFSAMEGENERATION <ONSAMELEVELAS <ANCESTORSOF <PARENTOF <DESCENDANTSOF <ALLSIBLINGSOF <LSIBLINGOF
mbrQuery - The member query string. A query string is a command similar to a report specification.com.essbase.api.base.EssException - if an error occurs.setSpanRelationalSource(boolean)
boolean isValidMember(java.lang.String mbrName)
throws com.essbase.api.base.EssException
mbrName - The member name to be verified.com.essbase.api.base.EssException - if an error occurs.
IEssMember getMember(java.lang.String mbrName)
throws com.essbase.api.base.EssException
mbrName - The member name.com.essbase.api.base.EssException - if an error occurs.
java.lang.String[] getMemberCalc(java.lang.String mbrName)
throws com.essbase.api.base.EssException
mbrName - The member name.com.essbase.api.base.EssException - if an error occurs.
IEssDimension getDimension(java.lang.String dimName)
throws com.essbase.api.base.EssException
dimName - The dimension name.com.essbase.api.base.EssException - if an error occurs.
IEssIterator getDimensions()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void buildDimension(java.lang.String rulesFileName,
int rulesFileType,
java.lang.String dataFileName,
int dataFileType,
java.lang.String errOutFile)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
void buildDimensionFile(java.lang.String rulesFileName,
int rulesFileType,
java.lang.String dataFileName,
int dataFileType,
java.lang.String errOutFile,
boolean overwriteErrFile)
throws com.essbase.api.base.EssException
buildDimensionStart() and succeeded by a restructure(short) call. This can be called repeatedly prior to restructuring to add members via multiple rules and/or data file to the outline. The database must be restructured after completion of the call(s) to this API. The outline must be unlocked after restructuring.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.overwriteErrFile - A Boolean value which detemines whether this operation overwrites an existing file name specified in errOutFile. if set to true, existing errOutFile will be overwritten and previos content of the file will be lost. If set to false, error records get appended to the existing errOutFile.com.essbase.api.base.EssException - if an error occurs.
void buildDimensionStart()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssExceptionbuildDimensionFile(String, int, String, int, String, boolean), restructure(short)
void restructure(short restructOption)
throws com.essbase.api.base.EssException
restructOption -com.essbase.api.base.EssException
IEssIterator getOlapFileObjects(int objType)
throws com.essbase.api.base.EssException
objType - The object types. Values from IEssOlapFileObject.TYPE_*.com.essbase.api.base.EssException - if an error occurs.
IEssOlapFileObject getOlapFileObject(int objType,
java.lang.String objName)
throws com.essbase.api.base.EssException
objType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.com.essbase.api.base.EssException - if an error occurs.
void copyOlapFileObjectFromServer(int objType,
java.lang.String objName,
java.lang.String clientFileName,
boolean lock)
throws com.essbase.api.base.EssException
copyOlapFileObjectFromServer(int, String, boolean) to copy the object to the client system in 3-tier mode(non embedded mode). Example:
copyOlapFileObjectFromServer(IEssOlapFileObject.TYPE_TEXT, "Act1", "C:/temp/act1.txt", false);objType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.clientFileName - The full path of destination file in the client. The file will be local to the server if not in Embedded mode.lock - Flag to control object locking. If true, the server object is locked to prevent updates by other users.com.essbase.api.base.EssException - if an error occurs.
byte[] copyOlapFileObjectFromServer(int objType,
java.lang.String objName,
boolean lock)
throws com.essbase.api.base.EssException
objType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.lock - Flag to control object locking. If true, the server object is locked to prevent updates by other users.com.essbase.api.base.EssException - if an Excepption occurs.
void copyOlapFileObjectToServer(int objType,
java.lang.String objName,
java.lang.String clientFileName,
boolean unlock)
throws com.essbase.api.base.EssException
copyOlapFileObjectToServer(int, String, byte[], boolean) to copy the object from client system in 3-tier mode(non embedded mode). Example:
copyOlapFileObjectToServer(IEssOlapFileObject.TYPE_TEXT, "Test", "C:/temp/test.txt", false);IEssOlapFileObject.TYPE_OUTLINE type object, the outline file will be copied as a ".otn" file on the server representing it as an intermediate Outline file. If this object name is same as the existing cube (or outline) name, then, performing a restructure operation on this cube will replace the .otn file as the outline file. This operation is not allowed for combined Object Types IEssOlapFileObject.TYPE_BACKUP, IEssOlapFileObject.TYPE_DATA, IEssOlapFileObject.TYPE_WORKSHEET and IEssOlapFileObject.TYPE_ALLobjType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.clientFileName - The full path of source file in the client. The file should be local to the server if not in embedded mode.unlock - Flag to control object locking. If true, the server object is unlocked.com.essbase.api.base.EssException - if an error occurs.
void copyOlapFileObjectToServer(int objType,
java.lang.String objName,
byte[] content,
boolean unlock)
throws com.essbase.api.base.EssException
objType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.content - The byte sequence of the object in the client.unlock - Flag to control object locking. If true, the server object is unlocked.com.essbase.api.base.EssException - if an error occurs.
void lockOlapFileObject(int objType,
java.lang.String objName)
throws com.essbase.api.base.EssException
objType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.com.essbase.api.base.EssException - if an error occurs.
void unlockOlapFileObject(int objType,
java.lang.String objName)
throws com.essbase.api.base.EssException
objType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.com.essbase.api.base.EssException - if an error occurs.
void createOlapFileObject(int objType,
java.lang.String objName)
throws com.essbase.api.base.EssException
objType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.com.essbase.api.base.EssException - if an error occurs.
void deleteOlapFileObject(int objType,
java.lang.String objName)
throws com.essbase.api.base.EssException
objType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.com.essbase.api.base.EssException - if an error occurs.
void renameOlapFileObject(int objType,
java.lang.String objName,
java.lang.String newObjName)
throws com.essbase.api.base.EssException
objType - The object type. Value from IEssOlapFileObject.TYPE_*.objName - The object name.com.essbase.api.base.EssException - if an error occurs.
void copyOlapFileObject(int objType,
java.lang.String objName,
java.lang.String destAppName,
java.lang.String destCubeName,
java.lang.String destObjName)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
void archiveBegin(java.lang.String archFileName)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
void archiveEnd()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void exportData(java.lang.String fileName,
IEssCube.EEssDataLevel dataLevel,
boolean columns)
throws com.essbase.api.base.EssException
fileName - The name of the server file to contain the exported information.dataLevel - Controls level of data to export.columns - Controls output of data blocks in column format (for creating rules files).com.essbase.api.base.EssException - if an error occurs.
void exportData(java.lang.String fileName,
IEssCube.EEssDataLevel dataLevel,
short columns)
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
java.lang.String[][] loadData(java.lang.String updateSpecs,
int rulesObjType,
java.lang.String rulesFileName,
boolean syntaxCheckOnly,
boolean unlockAfterUpdate,
boolean abortOnError)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
java.lang.String[][] loadData(int rulesObjType,
java.lang.String rulesFileName,
int dataObjType,
java.lang.String dataFileName,
boolean abortOnError,
java.lang.String userName,
java.lang.String password)
throws com.essbase.api.base.EssException
dataFileName needs to contain the name of the ftp source and userName and password to be nonempty. Only text files are supported from a client file-system. Returns an error-list only when rules files is specified. Example usage for demo/basic cube:
loadData( IEssOlapFileObject.TYPE_RULES, null, IEssOlapFileObject.TYPE_TEXT, "Data", false);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.userName - external data source username.password - external data source password.com.essbase.api.base.EssException - if an error occurs.
java.lang.String[][] loadData(int rulesObjType,
java.lang.String rulesFileName,
int dataObjType,
java.lang.String dataFileName,
boolean abortOnError)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
void loadData(boolean store,
boolean unlock,
java.lang.String updSpec)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
java.lang.String[][] loadDataEx(boolean store,
boolean unlock,
java.lang.String updSpec)
throws com.essbase.api.base.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.com.essbase.api.base.EssException
IEssCubeOutline beginIncrementalBuildDim()
throws com.essbase.api.base.EssException
IEssCube.incrementalBuildDim method one or more times. Caller API can use the returned outline handle to execute other outline editing API before invoking the endIncrementalBuildDim(short, String, String) call.com.essbase.api.base.EssException - if an error occurs.incrementalBuildDim(String, int, String, int, String, String, int, String, String, boolean)
java.lang.StringBuffer incrementalBuildDim(java.lang.String rulesFileName,
int rulesFileType,
java.lang.String dataFileName,
int dataFileType,
java.lang.String userName,
java.lang.String password,
int incBuildOption,
java.lang.String tmpOtlFilename,
java.lang.String ErrorFileName)
throws com.essbase.api.base.EssException
IEssCube.beginIncrementalBuildDim method. After you are done with the incremental builds, invoke IEssCube.endIncrementalBuildDim method to complete the process. The rule and data files can exist either on the server or the client file-system. To specify files from the client file-system, provide absolute/relative path to the file. To specify a file on the server, specify a path relative to the server. The file specified using a relative path is considered for a server location, only if it does not exist on the local system. If the the data file is to be ftp-ed, then, userName and password needs to be specified for the FTP authentication. Example of a FTP Data Souce: dataFileName = ftp://myhost/mycubeData.txtrulesFileName - Rules file name.rulesFileType - Rules file type (Example: IEssOlapFileObject.TYPE_RULES).dataFileName - Data file Name.dataFileType - Date file type (Example: IEssOlapFileObject.TYPE_TEXT).userName - Login-id, in the case of FTP based data source. Otherwise, can be null.password - Password, in the case of FTP based data source. Otherwise, can be null.incBuildOption - One of the IEssCube.ESS_INCDIMBUILD_* optionstmpOtlFilename - FileName for the Temporary Outline.ErrorFileName - - the absolute filename into which error should be written to.com.essbase.api.base.EssException - if an error occurs.beginIncrementalBuildDim()
java.lang.StringBuffer incrementalBuildDim(java.lang.String rulesFileName,
int rulesFileType,
java.lang.String dataFileName,
int dataFileType,
java.lang.String userName,
java.lang.String password,
int incBuildOption,
java.lang.String tmpOtlFilename,
java.lang.String ErrorFileName,
boolean addToBuffer)
throws com.essbase.api.base.EssException
IEssCube.beginIncrementalBuildDim method. After you are done with the incremental builds, invoke IEssCube.endIncrementalBuildDim method to complete the process. The rule and data files can exist either on the server or the client file-system. To specify files from the client file-system, provide absolute/relative path to the file. To specify a file on the server, specify a path relative to the server. The file specified using a relative path is considered for a server location, only if it does not exist on the local system. If the the data file is to be ftp-ed, then, userName and password needs to be specified for the FTP authentication. Example of a FTP Data Souce: dataFileName = ftp://myhost/mycubeData.txtrulesFileName - Rules file name.rulesFileType - Rules file type (Example: IEssOlapFileObject.TYPE_RULES).dataFileName - Data file Name.dataFileType - Date file type (Example: IEssOlapFileObject.TYPE_TEXT).userName - Login-id, in the case of FTP based data source. Otherwise, can be null.password - Password, in the case of FTP based data source. Otherwise, can be null.incBuildOption - One of the IEssCube.ESS_INCDIMBUILD_* optionstmpOtlFilename - FileName for the Temporary Outline.ErrorFileName - - the absolute filename into which error should be written to.addToBuffer - - if set to false then error records will not be appended to returning StringBuffercom.essbase.api.base.EssException - if an error occurs.beginIncrementalBuildDim()
java.lang.StringBuffer endIncrementalBuildDim(short RestructOption,
java.lang.String tmpOtlFilename,
java.lang.String ErrorFileName)
throws com.essbase.api.base.EssException
beginIncrementalBuildDim() call and closes it as well.RestructOption - - the Restructure option. Values are : ESS_DOR_ALLDATA, ESS_DOR_FORCE_ALLDATA, ESS_DOR_INDATA, ESS_DOR_LOWDATA, ESS_DOR_NODATA,tmpOtlFilename - FileName of the Temporary Outline you used in incrementalBuildDim.ErrorFileName - - the absolute filename into which error should be written to.com.essbase.api.base.EssException - if an error occurs.beginIncrementalBuildDim()
java.lang.StringBuffer endIncrementalBuildDim(short RestructOption,
java.lang.String tmpOtlFilename,
java.lang.String ErrorFileName,
boolean addToBuffer)
throws com.essbase.api.base.EssException
beginIncrementalBuildDim() call and closes it as well.RestructOption - - the Restructure option. Values are : ESS_DOR_ALLDATA, ESS_DOR_FORCE_ALLDATA, ESS_DOR_INDATA, ESS_DOR_LOWDATA, ESS_DOR_NODATA,tmpOtlFilename - FileName of the Temporary Outline you used in incrementalBuildDim.ErrorFileName - - the absolute filename into which error should be written to.addToBuffer - - if set to false then error records will not be appended to returning StringBuffercom.essbase.api.base.EssException - if an error occurs.beginIncrementalBuildDim()
void beginStreamBuildDim(java.lang.String rulesFileName,
int rulesFileType,
int incBuildOption,
java.lang.String tmpOtlFilename)
throws com.essbase.api.base.EssException
rulesFileName - Rules file name.rulesFileType - Rules file type (Example: IEssOlapFileObject.TYPE_RULES).incBuildOption - One of the IEssCube.ESS_INCDIMBUILD_* optionstmpOtlFilename - FileName for the Temporary Outline.com.essbase.api.base.EssException - if an error occurs.endStreamBuildDim(String, boolean)
java.lang.StringBuffer endStreamBuildDim(java.lang.String ErrorFileName)
throws com.essbase.api.base.EssException
ErrorFileName - - the absolute filename into which error should be written to.com.essbase.api.base.EssException - if an error occurs.endStreamBuildDim(String, boolean)
java.lang.StringBuffer endStreamBuildDim(java.lang.String ErrorFileName,
boolean addToBuffer)
throws com.essbase.api.base.EssException
ErrorFileName - - the absolute filename into which error should be written to.addToBuffer - - if set to false then error records will not be appended to returning StringBuffercom.essbase.api.base.EssException - if an error occurs.endStreamBuildDim(String)
void loadBufferInit(long bufferId,
long duplicateAggregationMethod,
long options,
long size)
throws com.essbase.api.base.EssException
bufferId - - desired buffer ID. It can be in range of 1 and 2147483647.duplicateAggregationMethod - - method to use for collision resolution within the buffer. One of the following constants describing how to combine multiple values for the same cell within the buffer Values are: ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD 0 ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL 1 ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST 2options - - a combination of the AD_UKR_LOAD_BUFFER_OPTION_XXX constants. Use bitwise OR (|) to specify multiple options; for example, ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES | ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES. values are: ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES 0x00000001 ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES 0x00000002size - - percentage of the total load buffer resources that the load buffer will be allowed to use; must be within [0, 100], and the value of 0 is interpreted as "default", which is currently 100. It's up to Essbase server to determine the actual value of the "default size". The operation fails if the total size of all load buffers exceeds 100.com.essbase.api.base.EssException
void loadBufferTerm(long[] bufferId,
long commitType,
long actionType,
long options)
throws com.essbase.api.base.EssException
bufferId - - the array of buffer identifierscommitType - - commit options values are: ESS_ASO_DATA_LOAD_BUFFER_STORE_DATA 0 ESS_ASO_DATA_LOAD_BUFFER_ADD_DATA 1 ESS_ASO_DATA_LOAD_BUFFER_SUBTRACT_DATA 2 ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_ALL_DATA 3 ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_INCREMENTAL_DATA 4actionType - - commit or abort. values are: ESS_ASO_DATA_LOAD_BUFFER_COMMIT 1 ESS_ASO_DATA_LOAD_BUFFER_ABORT 2options - Values are: ESS_ASO_DATA_LOAD_INCR_TO_MAIN_SLICE 0x00000000 ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE 0x00000001 ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE_LIGHTWEIGHT 0x00000002 ESS_ASO_DATA_LOAD_IN_USE_BIT_MASK 0x00000003com.essbase.api.base.EssException
com.essbase.api.datasource.EssLOADBUFFER[] listExistingLoadBuffers()
throws com.essbase.api.base.EssException
ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD: Add values when the buffer contains multiple values for the same cell. ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL: Verify that multiple values for the same cells are identical, and ignore the duplicates if they are. Stop the data load with an error message if they differ. ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST: Use the last value loaded into the buffer as the final value for the cell. EssLOADBUFFER.isInternal() - Returns true if the buffer was created by Essbase; returns false for user-created buffers EssLOADBUFFER.getOptionFlags() - Either (or a combination) of the following load buffer options: ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES EssLOADBUFFER.getSize() - Returns resource usagecom.essbase.api.base.EssException
void mergeDatabaseData(long options)
throws com.essbase.api.base.EssException
options - Values are: ESS_MERGE_DATABASE_DATA_ALL 1 ESS_MERGE_DATABASE_DATA_INCREMENTAL 2com.essbase.api.base.EssException
IEssCube.EEssCubeAccess getUserOrGroupAccess(java.lang.String userOrGroupName)
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
void setUserOrGroupAccess(java.lang.String userOrGroupName,
IEssCube.EEssCubeAccess access)
throws com.essbase.api.base.EssException
access - The cube access.com.essbase.api.base.EssException - if an error occurs.
IEssCube.IEssSecurityFilter createSecurityFilter(java.lang.String filterName)
throws com.essbase.api.base.EssException
filterName - Filter name, up to 30 characters long.com.essbase.api.base.EssException - if an error occurs.
void deleteSecurityFilter(java.lang.String filterName)
throws com.essbase.api.base.EssException
filterName - The filter name.com.essbase.api.base.EssException - if an error occurs.
IEssCube.IEssSecurityFilter getSecurityFilter(java.lang.String filterName)
throws com.essbase.api.base.EssException
filterName - The filter name.com.essbase.api.base.EssException - if an error occurs.
IEssCube.IEssSecurityFilter setSecurityFilter(java.lang.String filterName,
boolean Active,
IEssCube.EEssCubeAccess Access)
throws com.essbase.api.base.EssException
filterName - Filter name, up to 30 characters longActive - - Filter active flag. If true, the filter is set active, otherwise it is set inactive.Access - - access level.com.essbase.api.base.EssException - if an error occurs.
IEssIterator getSecurityFilters()
throws com.essbase.api.base.EssException
getSecurityFiltersWithNameOnly() if only filter names are required.com.essbase.api.base.EssException - if an error occurs.getSecurityFiltersWithNameOnly()
IEssIterator getSecurityFiltersWithNameOnly()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.getSecurityFilters()
void setSecurityFilterList(IEssCube.IEssSecurityFilter filter,
java.lang.String[] usersAndOrGroups)
throws com.essbase.api.base.EssException
filter - The Filter to which you want to link users and/or groups.usersAndOrGroups - List of Users and/or Groupscom.essbase.api.base.EssException - if an error occurs.
java.lang.String getPerformanceStatistics()
throws com.essbase.api.base.EssException
resetPerformanceStatisticsTables(4, 7);
String stats = getPerformanceStatistics();
com.essbase.api.base.EssException - if an error occurs.
void resetPerformanceStatisticsTables(int persistence,
int scope)
throws com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
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 com.essbase.api.base.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.com.essbase.api.base.EssException - if an error occurs.
void deleteLocationAlias(java.lang.String aliasName)
throws com.essbase.api.base.EssException
aliasName - The location alias name.com.essbase.api.base.EssException - if an error occurs.
java.lang.String[][] getLocationAliases()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
java.lang.String[][] getAssociatedAttributes(java.lang.String baseMbrName,
java.lang.String attrDimName)
throws com.essbase.api.base.EssException
baseMbrName - The base member name.attrDimName - The attribute dimension name (optional).com.essbase.api.base.EssException - if an error occurs.
void setSpanRelationalSource(boolean span)
throws com.essbase.api.base.EssException
span - true to span to relational source.com.essbase.api.base.EssException - if an error occurs.
boolean isSpanRelationalSource()
throws com.essbase.api.base.EssException
setSpanRelationalSource(boolean). This will return the value set using a earlier setSpanRelationalSource(boolean) with in the same session. By default value is false.com.essbase.api.base.EssException - if an error occurs.
boolean verifyFormula(java.lang.String formulaName)
throws com.essbase.api.base.EssException
formulaName - The name of the formula.com.essbase.api.base.EssException - if an error occurs.
java.lang.String getCalcFunctions()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - if an error occurs.
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 com.essbase.api.base.EssException
IEssOlapServer and IEssOlapApplication.appName - Application Name on which this function must be created.name - Function namejavaSpec - Java Specificationoptions - An option must be one of possible values of IEssCube.ESS_UDF_FUNCTION_*spec - Function specificationcomment - Description for this function.if - an error occurs.com.essbase.api.base.EssExceptionIEssOlapServer.createCDF(String, String, int, String, String), IEssOlapApplication.createCDF(String, String, int, String, String)
void deleteCDF(java.lang.String appName,
java.lang.String name)
throws com.essbase.api.base.EssException
IEssOlapServer and IEssOlapApplication.appName - Application Name associated with the specified function.name - Function that has to be deleted.if - an error occurs.com.essbase.api.base.EssExceptionIEssOlapServer.deleteCDF(String), IEssOlapApplication.deleteCDF(String)
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 com.essbase.api.base.EssException
IEssOlapServer and IEssOlapApplication.appName - Application Name on which this macro must be created.name - Macro namedefinition - Marco definitionsignature - Signature for this macro.spec - Specification for this macro.comment - Description for this macro.if - an error occurs.com.essbase.api.base.EssExceptionIEssOlapServer.createCDM(String, String, String, String, String), IEssOlapApplication.createCDM(String, String, String, String, String)
void deleteCDM(java.lang.String appName,
java.lang.String name)
throws com.essbase.api.base.EssException
IEssOlapServer and IEssOlapApplication.appName - Application Name associated with the specified macro.name - Macro that has to be deleted.if - an error occurs.com.essbase.api.base.EssExceptionIEssOlapServer.deleteCDM(String), IEssOlapApplication.deleteCDM(String)
java.lang.String[][] getCDM_CDF(java.lang.String appName)
throws com.essbase.api.base.EssException
IEssOlapServer and IEssOlapApplication.The result will consist of 'n' x 5 elements where 'n' represents the total number of custom functions and custom macros. For any 'x' value ranging from 0 to n-1,
Result [x][0] represents the Name
Result [x][1] represents the Specification
Result [x][2] represents the Comment
Result [x][3] represents either a value "cdf" or "cdm" to idic
Result [x][4] represents either a value "cdf" or "cdm".
appName - Application Nameif - an error occurs.com.essbase.api.base.EssExceptionIEssOlapServer.getCDM_CDF(), IEssOlapApplication.getCDM_CDF()
void createReferenceCube(java.lang.String locAlias,
IEssCube.EEssCubeletType clType,
long limit)
throws com.essbase.api.base.EssException
locAlias - - Location alias on the selected application and databaseclType - - The type of reference cube. Possible values are PASSIVE ACTIVElimit - - Size limit for the reference cubecom.essbase.api.base.EssException
void removeReferenceCube(java.lang.String locAlias)
throws com.essbase.api.base.EssException
locAlias - - Location alias on the selected application and database.com.essbase.api.base.EssException
void unloadReferenceCube(java.lang.String locAlias)
throws com.essbase.api.base.EssException
locAlias - - Location alias on the selected source application and database.com.essbase.api.base.EssException
void loadReferenceCube(java.lang.String locAlias)
throws com.essbase.api.base.EssException
locAlias - - Location alias on the selected source application and database.com.essbase.api.base.EssException
IEssReferenceCubeInfo[] listReferenceCubes()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void archiveDatabase(java.lang.String backupFileName,
java.lang.String optionsFileName,
boolean overWrite)
throws com.essbase.api.base.EssException
backupFileName - - Full path to the file where the back up need to be taken. The backup file will be created on the olap server, at the location specified For eg, if you invoke as archiveDatabase("C:/Hyperion/samplebasic.arc"), a file named 'samplebasic.arc' will be created at the location mentioned ie. C:/Hyperion on the olap server.optionsFileName - - Not used in this release. Reserved for the future, pass empty String in this release.overWrite - - Pass True if you want to over write to an existing backup file, false otherwise.com.essbase.api.base.EssException
void restoreDatabase(java.lang.String backupFileName,
boolean forceDiffName,
java.lang.String[] Src_Partitions,
java.lang.String[] Dest_Partitions)
throws com.essbase.api.base.EssException
The Database must be unloaded before restoring it.
backupFileName - - Full path to the file on the olap server from where restore need to be done.forceDiffName - - Pass true if you want to force restoring to different application or database name. If true is passed and the application and database name is same that the back up is taken, there is no difference from passing false.Src_Partitions - - A list of disk partition names to be replaced.Dest_Partitions - - A list Disk partition name with which the Corresponding source partition names need to be replaced.com.essbase.api.base.EssException
com.essbase.api.datasource.EssTRANSACTION[] listTransactions(short startTimeSrc,
java.lang.String startTime,
short listOption,
java.lang.String fileName)
throws com.essbase.api.base.EssException
startTimeSrc - - short, is time given as an input or based on restored database time stamp. Values are: ESS_TRLOG_TIMESPECIFIED - 1, ESS_TRLOG_TIMEFROMDB - 2.startTime - - String, in the format "MM/dd/yyyy:HH:mm:ss". Time input compared to which all the transactions need to be listedlistOption - - It can be one of IEssCube.ESS_LIST_TRANSACTIONS_* If this is IEssCube.ESS_LIST_TRANSACTIONS_TOFILE or ESS_LIST_TRANSACTIONS_FORCETOFILE out put is not returned in EssTRANSACTION[]. Instead the required content is written to the FileName as comma separated file. If the option is IEssCube.ESS_LIST_TRANSACTIONS_TOFILE, API will error out if the specified file name already exists. The file will be over written if IEssCube.ESS_LIST_TRANSACTIONS_FORCETOFILE is used.fileName - - String, the file namecom.essbase.api.base.EssException
void replayTransactions(com.essbase.api.datasource.EssTRANSACTION_REPLAY replayTran,
com.essbase.api.datasource.EssSEQID[] seqIds)
throws com.essbase.api.base.EssException
replayTran - - EssTRANSACTION_REPLAY, specifying input type and number of sequence id's/or time. Values for EssTRANSACTION_REPLAY.InpType are: ESS_REPLAY_BASED_GIVENTIME - 1, ESS_REPLAY_BASED_LASTREPLAYTIME - 2, ESS_REPLAY_BASED_SEQUENCEID - 3.seqIds - - Array of EssSEQID (can be just one).com.essbase.api.base.EssException
void setUMCData(java.lang.String UMC)
throws com.essbase.api.base.EssException
UMC -com.essbase.api.base.EssException
java.lang.String getUMCData()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void clearPartialData(java.lang.String regionSpec,
boolean isPhysical)
throws com.essbase.api.base.EssException
regionSpec - the MDX set expression which specifies the region to be cleared.isPhysical - if set true, data will be cleared physically(cells will be removed from cube) else logical clearing(cell value is set to 0) will be performed.com.essbase.api.base.EssException - if an error occurs.
IEssPerformAllocation getPerformAllocationInstance()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
IEssPerformCustomCalc getPerformCustomCalcInstance()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
boolean verifyMDXExpression(java.lang.String mdxExpression,
long exprType,
java.util.List outErrorsIfAny)
throws com.essbase.api.base.EssException
If the expression is invalid, then this operation will throw EssException indicating the error message details, plus, object will be populated with the list of detailed errors.
If the expression is valid, then, there will be no exception thrown. The return value is a status indicating whether the expression is completely valid or it has warnings. If it has warning(s), the status returned, will be false and your outErrorsIfAny list will be populated with the warning information. For instance, assuming [Scenario] is a dimension/member in your outline, then, "SUBSET(Scenario.Members, -1, 10)" is a executable MDX set expression, but, it will have a warning about a negative index in SUBSET function.
Refer MdxQuery.java sample for an example usage.
mdxExpression - the MDX expression to be validated on this cube.exprType - the MDX expression type. It can take one of the ESS_ASO_VERIFY_* values based type of expression that needs to be validated. Possible values are ESS_ASO_VERIFY_MEMBER_EXPR, ESS_ASO_VERIFY_TUPLE_EXPR, ESS_ASO_VERIFY_SET_EXPR, ESS_ASO_VERIFY_NUMERIC_EXPR. For example, if the expression to be validated is for POV, this argument should be set to ESS_ASO_VERIFY_SET_EXPR because POV is expected to be an MDX set expression.outErrorsIfAny - an output object for collecting the warnings/errors returned by Essbase. This object needs to be instantiated by the caller so that Essbase can populate the messages (if any). Note that, if this List object is non-empty, this operation will be appending the returned warnings/errors. So, if you are reusing your outErrorsIfAny object and like to see the errors corresponding to this particular call only, please make sure that you clear this list object before invoking this method. The list will contain elements of type EssPerformAllocationError only.com.essbase.api.base.EssException - if (1) the expression is invalid or (2) the operation failed for other reasons such as failing to connect to Essbase. In the second scenario, the exception message will indicate the error occured and there will be no errors returned within your outErrorsIfAny list operation failed before it could verify the expression.EssPerformAllocationError
void createDrillThroughURL(java.lang.String URLName,
boolean bIsLevel0,
java.lang.String URLLink,
java.lang.String[] drillRegions)
throws com.essbase.api.base.EssException
URLName - Name of the URL.bIsLevel0 -URLLink - URL XMLdrillRegions - List of Symmetric regions.com.essbase.api.base.EssException - If an error occurs.
IEssURLDrillThrough[] listDrillThroughURLs()
throws com.essbase.api.base.EssException
com.essbase.api.base.EssException - If an error occurs.
IEssURLDrillThrough getDrillThroughURL(java.lang.String URLName)
throws com.essbase.api.base.EssException
URLName - Name of the URL to be retrieved.com.essbase.api.base.EssException - If an error occurs.
java.lang.String[] getCellDrillThroughReports(java.lang.String[] pMembers)
throws com.essbase.api.base.EssException
pMembers - array of members which are part of member combination.com.essbase.api.base.EssException - If an error occurs.
java.lang.StringBuffer getAsyncProcessLog(java.lang.String ErrorFileName,
boolean overwrite,
boolean addToBuffer)
throws com.essbase.api.base.EssException
ErrorFileName - File name to which process log to be written.overwrite - if set to true it will overwrite the existing file.addToBuffer - - if set to false then error records will not be appended to returning StringBuffercom.essbase.api.base.EssException - if an error occurs
com.essbase.api.datasource.EssBuildDimDataLoadState getAsyncProcessState()
throws com.essbase.api.base.EssException
EssBuildDimDataLoadState structure.com.essbase.api.base.EssException - if an error occurs
java.lang.StringBuffer cancelAsyncProcess(java.lang.String ErrorFileName,
boolean overwrite,
boolean addToBuffer)
throws com.essbase.api.base.EssException
ErrorFileName - file name to which process log to be written.overwrite - if set to true it will overwrite the existing file.addToBuffer - - if set to false then error records will not be appended to returning StringBuffercom.essbase.api.base.EssException - if an error occurs.
com.essbase.api.datasource.EssBuildDimDataLoadState closeAsyncProcess()
throws com.essbase.api.base.EssException
EssBuildDimDataLoadState structure.com.essbase.api.base.EssException - if an error occurs.
void asyncBuildDimension(java.lang.String rulesFileName,
int rulesFileType,
java.lang.String dataFileName,
int dataFileType,
java.lang.String userName,
java.lang.String password,
int buildDimOptions,
java.lang.String tmpOtlFileName)
throws com.essbase.api.base.EssException
closeAsyncProcess() to close the connection.rulesFileName - Rules file name.rulesFileType - Rules file type (Example: IEssOlapFileObject.TYPE_RULES).dataFileName - Data file Name.dataFileType - Date file type (Example: IEssOlapFileObject.TYPE_TEXT).userName - Login-id, in the case of FTP based data source. Otherwise, can be null.password - Password, in the case of FTP based data source. Otherwise, can be null.buildDimOptions - One of the IEssCube.ESS_INCDIMBUILD_* optionstmpOtlFileName - FileName for the Temporary Outline.com.essbase.api.base.EssException - if an error occurs.
void asyncLoadData(int rulesObjType,
java.lang.String rulesFileName,
int dataObjType,
java.lang.String dataFileName,
boolean abortOnError,
java.lang.String userName,
java.lang.String password)
throws com.essbase.api.base.EssException
closeAsyncProcess() to close the connection. Only text files are supported from a client file-system.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.userName - external data source username.password - external data source password.com.essbase.api.base.EssException - if an error occurs
void asyncLoadData(int rulesFileType,
java.lang.String rulesFileName,
int dataFileType,
java.lang.String dataFileName,
boolean abortOnError,
java.lang.String userName,
java.lang.String password,
int bufferId)
throws com.essbase.api.base.EssException
closeAsyncProcess() to close the connection. Only text files are supported from a client file-system.rulesFileType - 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".dataFileType - 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.userName - external data source username.password - external data source password.bufferId - The Buffer Identifier.com.essbase.api.base.EssException - if an error occurs.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||