com.essbase.api.datasource

Interface IEssCubeDataloadInstance

public interface IEssCubeDataloadInstance

The interface used to setup the input parameters for data load.

Method Summary

Modifier and Type	Method and Description
boolean	getAbortOnError()
java.lang.String	getDataFile()
int	getDataFileType() Get the datafile object type
short	getNumPipes()
java.lang.String	getRulesFile() Get the rules file name
void	setAbortOnError(boolean abortOnError) If true import stops on the first error otherwise continues.
void	setDataFile(java.lang.String dataFile) Sets The data file name in the olap server's app/cube directory.
void	setDataFileType(int dataFileType) Sets The data file object type.
void	setNumPipes(short numPipes) In case of parallel dataload using multiple data files, the numPipes denotes number of pipes or threads that will be used for loading data files in parallel.
void	setRulesFile(java.lang.String rulesFile) Sets The rules file name in the olap server.

Method Detail

getRulesFile

java.lang.String getRulesFile()

Get the rules file name

Returns:

the rules file name.

Since:

11.1.2.2

setRulesFile

void setRulesFile(java.lang.String rulesFile)

Sets 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".

Parameters:

rulesFile - the name of the rules file. since 11.1.2.2

getDataFileType

int getDataFileType()

Get the datafile object type

Returns:

the data file type. Values from IEssOlapFileObject.TYPE_*.

Since:

11.1.2.2

setDataFileType

void setDataFileType(int dataFileType)

Sets The data file object type. Values from IEssOlapFileObject.TYPE_*.

Parameters:

dataFileType - the data file type

Since:

11.1.2.2

getDataFile

java.lang.String getDataFile()

setDataFile

void setDataFile(java.lang.String dataFile)

Sets 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". Or for data files residing on client machine, the file name with the path. eg. "C:/data" In case of Parallel dataload, the data file spec can contain the wildcard ('*' or '?')specification.

Parameters:

dataFile - the datafile specification.

Since:

11.1.2.2

getNumPipes

short getNumPipes()

setNumPipes

void setNumPipes(short numPipes)

In case of parallel dataload using multiple data files, the numPipes denotes number of pipes or threads that will be used for loading data files in parallel. For server side data files, the numPipes denotes the number of pipes that server will use internally for loading datafiles in parallel. For client side data files, the numPipes denotes the number of threads that API will create to load data files in parallel. In case of negative or default value (0) is specified, the client/server will internally decide on the optimal value used of numPipes.

Parameters:

numPipes - The number of pipes/threads.

Since:

11.1.2.2

getAbortOnError

boolean getAbortOnError()

Returns:

abort on error flag

Since:

11.1.2.2

setAbortOnError

void setAbortOnError(boolean abortOnError)

If true import stops on the first error otherwise continues.

Parameters:

abortOnError - true if needed to stop on first error.

Since:

11.1.2.2