|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bea.ld.QueryAttributes
NOTE: This class should not be considered part of the mediator
API any longer. It remains in the documentation for backwards
compatibility reasons; however, new code (which utilitizes the
com.bea.dsp.dsmediator.client package) should not use it.
Refer to RequestConfig
instead.
Collection of attributes which control how a query is to be invoked.
There are two kinds of attributes - normal and feature flags.
QueryAttributes.setAttribute(String,String)
, QueryAttributes.setIntegerAttribute(String,int)
, or QueryAttributes.setStringArrayAttribute(String,String[])
. These all default to
null or 0.
QueryAttributes.enableFeature(String)
, and
disable them with QueryAttributes.disableFeature(java.lang.String)
.
disableFeature()
to "turn off" a string-valued normal
attribute; set it to null
instead.
Field Summary | |
static java.lang.String |
COMPILE_ONLY
Feature flag requesting query processor only compile the query, not execute it. |
static java.lang.String |
DO_NOT_CACHE_QUERY_PLAN
Feature flag requesting query processor not to cache compiled execution plan |
static java.lang.String |
FORCE_COMPILE
Feature flag requesting query processor recompile query, instead of using any previously-cached version. |
static java.lang.String |
GET_CURRENT_DATA
Feature flag requesting that cached content should be ignored, data computed and cached entries used in the current query refreshed |
static java.lang.String |
REFRESH_CACHE_EARLY
Integer attribute requesting that a cached data record must be valid for at least the specified number of seconds. |
static java.lang.String |
RETURN_AUDIT_PROPERTIES
String[] list of audit properties that would be enabled and returned if allowed. |
static java.lang.String |
RETURN_DATA_SERVICE_AUDIT
Feature flag requesting query processor to return all returnable audit properties collected. |
static java.lang.String |
TIMEOUT
Integer attribute specifying maximum time the query engine should allow for this request to complete (in milliseconds). |
Constructor Summary | |
QueryAttributes()
|
Method Summary | |
void |
disableFeature(java.lang.String featureName)
Disable a specified feature flag for this query execution. |
void |
enableFeature(java.lang.String featureName)
Enable a specified feature flag for this query execution. |
boolean |
featureEnabled(java.lang.String featureName)
Inquire whether a particular feature is enabled or not for this query execution. |
java.lang.String |
getAttribute(java.lang.String attributeName)
Retrieve a String-valued attribute. |
int |
getIntegerAttribute(java.lang.String attributeName)
Retrieve an int-valued attribute. |
java.lang.String[] |
getStringArrayAttribute(java.lang.String attributeName)
Retrieve a String array-valued attribute. |
void |
setAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
Provide a String value for an attribute for this query execution. |
void |
setIntegerAttribute(java.lang.String attributeName,
int value)
Provide an integer value for an attribute for this query execution. |
void |
setStringArrayAttribute(java.lang.String attributeName,
java.lang.String[] attributeValue)
Provide a String array value for an attribute for this query execution. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String COMPILE_ONLY
public static final java.lang.String FORCE_COMPILE
public static final java.lang.String DO_NOT_CACHE_QUERY_PLAN
public static final java.lang.String RETURN_AUDIT_PROPERTIES
public static final java.lang.String RETURN_DATA_SERVICE_AUDIT
public static final java.lang.String GET_CURRENT_DATA
public static final java.lang.String REFRESH_CACHE_EARLY
public static final java.lang.String TIMEOUT
Note: If the request is participating in an EJB transaction, then the EJB's transaction timeout (trans-timeout-seconds in the deployment descriptor) may override this timeout if the EJB's timeout is smaller.
Constructor Detail |
public QueryAttributes()
Method Detail |
public void setAttribute(java.lang.String attributeName, java.lang.String attributeValue)
public void setStringArrayAttribute(java.lang.String attributeName, java.lang.String[] attributeValue)
public void setIntegerAttribute(java.lang.String attributeName, int value)
public void enableFeature(java.lang.String featureName)
public void disableFeature(java.lang.String featureName)
enableFeature()
.)
public boolean featureEnabled(java.lang.String featureName)
public java.lang.String getAttribute(java.lang.String attributeName)
public java.lang.String[] getStringArrayAttribute(java.lang.String attributeName)
public int getIntegerAttribute(java.lang.String attributeName)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |