|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssMaxlSession
The IEssMaxlSession interface.
Field Summary | |
---|---|
static int |
PROP_NAME |
static int |
s_countProperties |
static IEssValueAny.EEssDataType[] |
s_propDataTypes |
static IEssProperties.EEssPropertyMode[] |
s_propModes |
static java.lang.String[] |
s_propNames |
Method Summary | |
---|---|
void |
close() Disconnects the maxl session from the olap server. |
void |
enablePaging(boolean enable) Indicates that the results should be transfered to the client system. |
boolean |
execute(java.lang.String maxlStatement) Executes the given maxl script statement. |
java.util.ArrayList |
getMessages() Returns the messages generated during the execution of the statement and retrieving the result. |
java.lang.String |
getName() Gets the name of this maxl session. |
IEssMaxlResultSet |
getResultSet() Gets the result of the last maxl statement executed. |
void |
setDelimiter(char delimiter) Characted to be used as delimiter while writing output to file. |
void |
setExternalTypes(java.util.HashMap typesMap) Allows specifying custom data types. |
void |
setResultSetFetchSize(int size) Gives the MAXL statement engine a hint as to the number of rows that should be fetched from the Essbase when more rows are needed for this ResultSet object. |
void |
updateMaxLOptions() Sends the additional options to the server. |
void |
writeToFile(java.io.File localfile) Writes output to the specified local file in UTF-8 format. |
Field Detail |
---|
static final int PROP_NAME
static final int s_countProperties
static final java.lang.String[] s_propNames
static final IEssValueAny.EEssDataType[] s_propDataTypes
static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
---|
java.lang.String getName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occur.boolean execute(java.lang.String maxlStatement) throws com.essbase.api.base.EssException
maxlStatement
- The maxl script statement that has to be executed.com.essbase.api.base.EssException
- if an error occurs.IEssMaxlResultSet getResultSet() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setResultSetFetchSize(int size)
size
- Max No. of rows to be fetched from the Essbase.void close() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void enablePaging(boolean enable) throws com.essbase.api.base.EssException
updateMaxLOptions()
for the property to get set.enable
- - boolean, true to enable paging, default is falsecom.essbase.api.base.EssException
void writeToFile(java.io.File localfile) throws com.essbase.api.base.EssException
execute(String)()
.localfile
- - java.io.File instance for the outputcom.essbase.api.base.EssException
void setDelimiter(char delimiter) throws com.essbase.api.base.EssException
updateMaxLOptions()
for the property to get set.delimiter
-com.essbase.api.base.EssException
void updateMaxLOptions() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void setExternalTypes(java.util.HashMap typesMap) throws com.essbase.api.base.EssException
updateMaxLOptions()
for the property to get set.typesMap
-com.essbase.api.base.EssException
java.util.ArrayList getMessages() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |