|
|||||||||||
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
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_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 |
DIRECT_PRESENTATION
|
static int |
EXPR_VALUE_STREAM
stream id for internal use, don't use it externally |
static int |
GROUP_INFO_STREAM
|
static int |
MODE_GENERATION
three defined mode |
static int |
MODE_PRESENTATION
|
static int |
RESULTCLASS_STREAM
|
static int |
SUBQUERY_INFO_STREAM
|
Method Summary | |
int |
getCacheCount()
|
int |
getCacheOption()
|
java.io.InputStream |
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()
|
int |
getMode()
|
java.io.OutputStream |
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. |
boolean |
hasStream(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)
When mode is MODE_GENERATION, the writer stream of archive will be used. |
void |
setCacheOption(int option,
int cacheCount)
This method is used to set the cache option for current data engine instance. |
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 CACHE_USE_DEFAULT
public static final int CACHE_USE_DISABLE
public static final int CACHE_USE_ALWAYS
public static final int EXPR_VALUE_STREAM
public static final int RESULTCLASS_STREAM
public static final int GROUP_INFO_STREAM
public static final int SUBQUERY_INFO_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) throws org.eclipse.birt.core.exception.BirtException
mode
- scope
- reader
- writer
-
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 java.io.OutputStream 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 hasStream(java.lang.String streamID, java.lang.String subStreamID, int streamType)
streamID
- subStreamID
- streamType
-
public java.io.InputStream 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
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |