|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.data.engine.api.DataEngineContext
public class DataEngineContext
Define in which context Data Engine is running. The context can be divided into three types: generation, presentation and direct presentation.
Field Summary | |
---|---|
static int |
CACHE_MODE_IN_DISK
|
static int |
CACHE_MODE_IN_MEMORY
|
static int |
CACHE_USE_ALWAYS
Always use cached data if available, disregard data set cache setting and AppContext. |
static int |
CACHE_USE_DEFAULT
AppContext and Data Set cache count setting decide whether cache is used, which is default value for data engine context. |
static int |
CACHE_USE_DISABLE
Do not use cache, regardless of data set cache setting |
static int |
DATASET_DATA_LEN_STREAM
|
static int |
DATASET_DATA_STREAM
|
static int |
DATASET_META_STREAM
|
static int |
DIRECT_PRESENTATION
|
static int |
EXPR_META_STREAM
|
static int |
EXPR_ROWLEN_STREAM
|
static int |
EXPR_VALUE_STREAM
|
static int |
GROUP_INFO_STREAM
|
static int |
META_INDEX_STREAM
|
static int |
META_STREAM
|
static int |
MODE_GENERATION
three defined mode |
static int |
MODE_PRESENTATION
|
static int |
MODE_UPDATE
this is a special mode, that a query which is running on a report document also needs to be stored into the same report document. |
static int |
NAMING_RELATION_STREAM
|
static int |
ORIGINAL_QUERY_DEFN_STREAM
|
static int |
PLS_GROUPLEVEL_STREAM
|
static int |
QUERY_DEFN_STREAM
|
static int |
QUERYID_INFO_STREAM
|
static int |
ROW_INDEX_STREAM
|
static int |
SUBQUERY_INFO_STREAM
|
static int |
SUBQUERY_PARENTINDEX_STREAM
|
static int |
VERSION_INFO_STREAM
stream id for internal use, don't use it externally |
Method Summary | |
---|---|
void |
dropStream(java.lang.String streamPath)
Directly drop stream |
void |
dropStream(java.lang.String streamID,
java.lang.String subStreamID,
int streamType)
|
int |
getCacheCount()
|
int |
getCacheOption()
|
java.lang.ClassLoader |
getClassLoader()
|
org.eclipse.birt.core.archive.IDocArchiveReader |
getDocReader()
|
org.eclipse.birt.core.archive.IDocArchiveWriter |
getDocWriter()
|
org.eclipse.birt.core.archive.RAInputStream |
getInputStream(java.lang.String streamID,
java.lang.String subStreamID,
int streamType)
According to the paramters of streamID, subStreamID and streamType, an input stream will be created for it. |
org.mozilla.javascript.Scriptable |
getJavaScriptScope()
|
com.ibm.icu.util.ULocale |
getLocale()
|
int |
getMode()
|
org.eclipse.birt.core.archive.RAOutputStream |
getOutputStream(java.lang.String streamID,
java.lang.String subStreamID,
int streamType)
According to the paramters of streamID, subStreamID and streamType, an output stream will be created for it. |
static java.lang.String |
getPath(java.lang.String streamID,
java.lang.String subStreamID,
int streamType)
|
org.eclipse.birt.core.script.ScriptContext |
getScriptContext()
|
java.lang.String |
getTmpdir()
get Dte temporary dir. |
boolean |
hasInStream(java.lang.String streamID,
java.lang.String subStreamID,
int streamType)
|
boolean |
hasOutStream(java.lang.String streamID,
java.lang.String subStreamID,
int streamType)
Determins whether one particular stream exists |
static DataEngineContext |
newInstance(int mode,
org.mozilla.javascript.Scriptable scope,
org.eclipse.birt.core.archive.IDocArchiveReader reader,
org.eclipse.birt.core.archive.IDocArchiveWriter writer)
Deprecated. |
static DataEngineContext |
newInstance(int mode,
org.mozilla.javascript.Scriptable scope,
org.eclipse.birt.core.archive.IDocArchiveReader reader,
org.eclipse.birt.core.archive.IDocArchiveWriter writer,
java.lang.ClassLoader classLoader)
Deprecated. |
static DataEngineContext |
newInstance(int mode,
org.eclipse.birt.core.script.ScriptContext context,
org.eclipse.birt.core.archive.IDocArchiveReader reader,
org.eclipse.birt.core.archive.IDocArchiveWriter writer,
java.lang.ClassLoader classLoader)
|
void |
setCacheOption(int option,
int cacheCount)
This method is used to set the cache option for current data engine instance. |
void |
setClassLoader(java.lang.ClassLoader classLoader)
Set the classloader. |
void |
setLocale(java.util.Locale locale)
|
void |
setTmpdir(java.lang.String tmpdir)
set Dte temporary dir. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int MODE_GENERATION
public static final int MODE_PRESENTATION
public static final int DIRECT_PRESENTATION
public static final int MODE_UPDATE
public static final int CACHE_USE_DEFAULT
public static final int CACHE_USE_DISABLE
public static final int CACHE_USE_ALWAYS
public static final int CACHE_MODE_IN_MEMORY
public static final int CACHE_MODE_IN_DISK
public static final int VERSION_INFO_STREAM
public static final int DATASET_DATA_STREAM
public static final int DATASET_META_STREAM
public static final int DATASET_DATA_LEN_STREAM
public static final int EXPR_VALUE_STREAM
public static final int EXPR_META_STREAM
public static final int EXPR_ROWLEN_STREAM
public static final int GROUP_INFO_STREAM
public static final int SUBQUERY_INFO_STREAM
public static final int QUERY_DEFN_STREAM
public static final int ORIGINAL_QUERY_DEFN_STREAM
public static final int ROW_INDEX_STREAM
public static final int QUERYID_INFO_STREAM
public static final int SUBQUERY_PARENTINDEX_STREAM
public static final int META_STREAM
public static final int META_INDEX_STREAM
public static final int NAMING_RELATION_STREAM
public static final int PLS_GROUPLEVEL_STREAM
Method Detail |
---|
public static DataEngineContext newInstance(int mode, org.mozilla.javascript.Scriptable scope, org.eclipse.birt.core.archive.IDocArchiveReader reader, org.eclipse.birt.core.archive.IDocArchiveWriter writer, java.lang.ClassLoader classLoader) throws org.eclipse.birt.core.exception.BirtException
mode
- scope
- reader
- writer
- the
- ClassLoader used for this data engine.
org.eclipse.birt.core.exception.BirtException
public static DataEngineContext newInstance(int mode, org.mozilla.javascript.Scriptable scope, org.eclipse.birt.core.archive.IDocArchiveReader reader, org.eclipse.birt.core.archive.IDocArchiveWriter writer) throws org.eclipse.birt.core.exception.BirtException
mode
- scope
- reader
- writer
-
org.eclipse.birt.core.exception.BirtException
public static DataEngineContext newInstance(int mode, org.eclipse.birt.core.script.ScriptContext context, org.eclipse.birt.core.archive.IDocArchiveReader reader, org.eclipse.birt.core.archive.IDocArchiveWriter writer, java.lang.ClassLoader classLoader) throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
public int getMode()
public org.mozilla.javascript.Scriptable getJavaScriptScope()
public int getCacheOption()
public int getCacheCount()
public void setCacheOption(int option, int cacheCount) throws org.eclipse.birt.core.exception.BirtException
option
- cacheCount
-
org.eclipse.birt.core.exception.BirtException
public org.eclipse.birt.core.archive.RAOutputStream getOutputStream(java.lang.String streamID, java.lang.String subStreamID, int streamType) throws org.eclipse.birt.data.engine.core.DataException
streamID
- subStreamID
- streamType
-
org.eclipse.birt.data.engine.core.DataException
public boolean hasOutStream(java.lang.String streamID, java.lang.String subStreamID, int streamType)
streamID
- subStreamID
- streamType
-
public boolean hasInStream(java.lang.String streamID, java.lang.String subStreamID, int streamType)
streamID
- subStreamID
- streamType
-
public void dropStream(java.lang.String streamID, java.lang.String subStreamID, int streamType)
streamID
- subStreamID
- streamType
- public void dropStream(java.lang.String streamPath)
streamPath
- public org.eclipse.birt.core.archive.RAInputStream getInputStream(java.lang.String streamID, java.lang.String subStreamID, int streamType) throws org.eclipse.birt.data.engine.core.DataException
streamID
- subStreamID
- streamType
-
org.eclipse.birt.data.engine.core.DataException
public void setLocale(java.util.Locale locale)
locale
- The current task's localepublic com.ibm.icu.util.ULocale getLocale()
public java.lang.String getTmpdir()
public void setTmpdir(java.lang.String tmpdir)
tmpdir
- public void setClassLoader(java.lang.ClassLoader classLoader)
classLoader
- public org.eclipse.birt.core.archive.IDocArchiveReader getDocReader()
public org.eclipse.birt.core.archive.IDocArchiveWriter getDocWriter()
public java.lang.ClassLoader getClassLoader()
public static java.lang.String getPath(java.lang.String streamID, java.lang.String subStreamID, int streamType)
streamType
-
public org.eclipse.birt.core.script.ScriptContext getScriptContext()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |