public class SaxonXQStaticContext extends Object implements XQStaticContext
| Constructor and Description |
|---|
SaxonXQStaticContext(Configuration config)
Create a SaxonXQStaticContext object, the Saxon implementation of XQStaticContext in XQJ
|
SaxonXQStaticContext(SaxonXQStaticContext sc)
Create a SaxonXQStaticContext object as a copy of another SaxonXQStaticContext object
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
checkNotNull(Object arg) |
void |
declareNamespace(String prefix,
String uri)
Declares a namespace prefix and associates it with a namespace URI.
|
String |
getBaseURI()
Gets the Base URI, if set in the static context, else the empty string.
|
int |
getBindingMode()
Gets the value of the binding mode property.
|
int |
getBoundarySpacePolicy()
Gets the boundary-space policy defined in the static context.
|
int |
getConstructionMode()
Gets the construction mode defined in the static context.
|
XQItemType |
getContextItemStaticType()
Gets the static type of the context item.
|
int |
getCopyNamespacesModeInherit()
Gets the inherit part of the copy-namespaces mode
defined in the static context.
|
int |
getCopyNamespacesModePreserve()
Gets the preserve part of the copy-namespaces mode
defined in the static context.
|
String |
getDefaultCollation()
Gets the URI of the default collation.
|
String |
getDefaultElementTypeNamespace()
Gets the URI of the default element/type namespace, the empty string
if not set.
|
String |
getDefaultFunctionNamespace()
Gets the URI of the default function namespace, the empty string
if not set.
|
int |
getDefaultOrderForEmptySequences()
Gets the default order for empty sequences defined in the static context.
|
int |
getHoldability()
Gets the value of the holdability property.
|
String[] |
getNamespacePrefixes()
Returns the prefixes of all the statically known namespaces.
|
String |
getNamespaceURI(String prefix)
Retrieves the namespace URI associated with a prefix.
|
int |
getOrderingMode()
Gets the ordering mode defined in the static context.
|
int |
getQueryLanguageTypeAndVersion()
Gets the value of the language type and version property.
|
int |
getQueryTimeout()
Retrieves the number of seconds an implementation will wait for a
query to execute.
|
protected StaticQueryContext |
getSaxonStaticQueryContext()
Get a new Saxon StaticQueryContext object holding the information held in this
XQStaticContext
|
int |
getScrollability()
Gets the value of the scrollability property.
|
void |
setBaseURI(String baseUri)
Sets the Base URI in the static context, specify the empty string to make it undefined.
|
void |
setBindingMode(int bindingMode)
Sets the binding mode property.
|
void |
setBoundarySpacePolicy(int policy)
Sets the boundary-space policy in the static context.
|
void |
setConstructionMode(int mode)
Sets the construction mode in the static context.
|
void |
setContextItemStaticType(XQItemType contextItemType)
Sets the static type of the context item, specify
null
to make it unspecified. |
void |
setCopyNamespacesModeInherit(int mode)
Sets the inherit part of the copy-namespaces mode in the static context.
|
void |
setCopyNamespacesModePreserve(int mode)
Sets the preserve part of the copy-namespaces mode in the static context.
|
void |
setDefaultCollation(String uri)
Sets the URI of the default collation.
|
void |
setDefaultElementTypeNamespace(String uri)
Sets the URI of the default element/type namespace, the empty string
to make it unspecified.
|
void |
setDefaultFunctionNamespace(String uri)
Sets the URI of the default function namespace, the empty string
to make it unspecified.
|
void |
setDefaultOrderForEmptySequences(int order)
Sets the default order for empty sequences in the static context.
|
void |
setHoldability(int holdability)
Sets the holdability property.
|
void |
setOrderingMode(int mode)
Sets the ordering mode in the static context.
|
void |
setQueryLanguageTypeAndVersion(int langtype)
Sets the input query language type and version.
|
void |
setQueryTimeout(int seconds)
Sets the number of seconds an implementation will wait for a
query to execute.
|
void |
setScrollability(int scrollability)
Sets the scrollability of the result sequence.
|
public SaxonXQStaticContext(Configuration config)
config - the Saxon configurationpublic SaxonXQStaticContext(SaxonXQStaticContext sc)
sc - the static context to be copiedprotected StaticQueryContext getSaxonStaticQueryContext()
public void declareNamespace(String prefix, String uri) throws XQException
XQStaticContextdeclareNamespace in interface XQStaticContextprefix - the prefix for the namespace URIuri - the namespace URI. An empty string
undeclares the specific prefix. Cannot be nullXQException - if (1) a null prefix, or (2) a null namespace
URI is specifiedpublic String getBaseURI()
XQStaticContextgetBaseURI in interface XQStaticContextnull..public int getBindingMode()
XQStaticContextgetBindingMode in interface XQStaticContextXQConstants.BINDING_MODE_IMMEDIATE,
orXQConstants.BINDING_MODE_DEFERRED.public int getBoundarySpacePolicy()
XQStaticContextgetBoundarySpacePolicy in interface XQStaticContextXQConstants.BOUNDARY_SPACE_PRESERVE,
XQConstants.BOUNDARY_SPACE_STRIP.public int getConstructionMode()
XQStaticContextgetConstructionMode in interface XQStaticContextXQConstants.CONSTRUCTION_MODE_PRESERVE,
XQConstants.CONSTRUCTION_MODE_STRIPpublic XQItemType getContextItemStaticType()
XQStaticContextnull if unspecified.getContextItemStaticType in interface XQStaticContextnullpublic int getCopyNamespacesModeInherit()
XQStaticContextgetCopyNamespacesModeInherit in interface XQStaticContextXQConstants.COPY_NAMESPACES_MODE_INHERIT,
XQConstants.COPY_NAMESPACES_MODE_NO_INHERIT.public int getCopyNamespacesModePreserve()
XQStaticContextgetCopyNamespacesModePreserve in interface XQStaticContextXQConstants.COPY_NAMESPACES_MODE_PRESERVE,
XQConstants.COPY_NAMESPACES_MODE_NO_PRESERVE.public String getDefaultCollation()
XQStaticContextgetDefaultCollation in interface XQStaticContextnull.public String getDefaultElementTypeNamespace()
XQStaticContextgetDefaultElementTypeNamespace in interface XQStaticContextnullpublic String getDefaultFunctionNamespace()
XQStaticContextgetDefaultFunctionNamespace in interface XQStaticContextnullpublic int getDefaultOrderForEmptySequences()
XQStaticContextgetDefaultOrderForEmptySequences in interface XQStaticContextXQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_GREATEST,
XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_LEAST.public String[] getNamespacePrefixes()
XQStaticContextgetNamespaceURI method to look up the namespace URI
corresponding to a specific prefix.getNamespacePrefixes in interface XQStaticContextString array containing the namespace prefixes.
Cannot be nullpublic String getNamespaceURI(String prefix) throws XQException
XQStaticContextXQException
is thrown if an unknown prefix is specified, i.e. a prefix not returned by the
getInScopeNamespacePrefixes method.getNamespaceURI in interface XQStaticContextprefix - the prefix for which the namespace URI is sought. Cannot
be nullnullXQException - if a null prefix is specified or if the prefix
is unknownpublic int getOrderingMode()
XQStaticContextgetOrderingMode in interface XQStaticContextXQConstants.ORDERING_MODE_ORDERED,
XQConstants.ORDERING_MODE_UNORDERED.public int getHoldability()
XQStaticContextgetHoldability in interface XQStaticContextXQConstants.HOLDTYPE_HOLD_CURSORS_OVER_COMMIT,
or XQConstants.HOLDTYPE_CLOSE_CURSORS_AT_COMMIT.public int getQueryLanguageTypeAndVersion()
XQStaticContextXQConstants.LANGTYPE_XQUERY.getQueryLanguageTypeAndVersion in interface XQStaticContextXQConstants.LANGTYPE_XQUERY,
or XQConstants.LANGTYPE_XQUERYX
or a negative value indicating a vendor specific
query language type and version.public int getQueryTimeout()
XQStaticContextgetQueryTimeout in interface XQStaticContextpublic int getScrollability()
XQStaticContextgetScrollability in interface XQStaticContextXQConstants.SCROLLTYPE_FORWARD_ONLY, or
XQConstants.SCROLLTYPE_SCROLLABLE.public void setBaseURI(String baseUri) throws XQException
XQStaticContextsetBaseURI in interface XQStaticContextbaseUri - the new baseUri, or empty string to make it undefined.
Cannot be null.XQException - if a null base uri is specifiedpublic void setBindingMode(int bindingMode)
throws XQException
XQStaticContextsetBindingMode in interface XQStaticContextbindingMode - the binding mode. One of:
XQConstants.BINDING_MODE_IMMEDIATE,
orXQConstants.BINDING_MODE_DEFERRED.XQException - the specified mode is different from
XQConstants.BINDING_MODE_IMMEDIATE,
XQConstants.BINDING_MODE_DEFERREDpublic void setBoundarySpacePolicy(int policy)
throws XQException
XQStaticContextsetBoundarySpacePolicy in interface XQStaticContextpolicy - boundary space policy. One of:
XQConstants.BOUNDARY_SPACE_PRESERVE,
XQConstants.BOUNDARY_SPACE_STRIP.XQException - the specified mode is different from
XQConstants.BOUNDARY_SPACE_PRESERVE,
XQConstants.BOUNDARY_SPACE_STRIPpublic void setConstructionMode(int mode)
throws XQException
XQStaticContextsetConstructionMode in interface XQStaticContextmode - construction mode value. One of:
XQConstants.CONSTRUCTION_MODE_PRESERVE,
XQConstants.CONSTRUCTION_MODE_STRIP.XQException - the specified mode is different from
XQConstants.CONSTRUCTION_MODE_PRESERVE,
XQConstants.CONSTRUCTION_MODE_STRIPpublic void setContextItemStaticType(XQItemType contextItemType)
XQStaticContextnull
to make it unspecified.setContextItemStaticType in interface XQStaticContextcontextItemType - the static type of the context item;
null if unspecified.public void setCopyNamespacesModeInherit(int mode)
throws XQException
XQStaticContextsetCopyNamespacesModeInherit in interface XQStaticContextmode - ordering mode value. One of:
XQConstants.COPY_NAMESPACES_MODE_INHERIT,
XQConstants.COPY_NAMESPACES_MODE_NO_INHERIT.XQException - the specified mode is different from
XQConstants.COPY_NAMESPACES_MODE_INHERIT,
XQConstants.COPY_NAMESPACES_MODE_NO_INHERITpublic void setCopyNamespacesModePreserve(int mode)
throws XQException
XQStaticContextsetCopyNamespacesModePreserve in interface XQStaticContextmode - ordering mode value. One of:
XQConstants.COPY_NAMESPACES_MODE_PRESERVE,
XQConstants.COPY_NAMESPACES_MODE_NO_PRESERVE.XQException - the specified mode is different from
XQConstants.COPY_NAMESPACES_MODE_PRESERVE,
XQConstants.COPY_NAMESPACES_MODE_NO_PRESERVEpublic void setDefaultCollation(String uri) throws XQException
XQStaticContextsetDefaultCollation in interface XQStaticContexturi - the namespace URI of the default collation.
Cannot be null.XQException - if a null URI is specifiedpublic void setDefaultElementTypeNamespace(String uri) throws XQException
XQStaticContextsetDefaultElementTypeNamespace in interface XQStaticContexturi - the namespace URI of the default element/type namespace,
the empty string to make it unspecified.
Cannot be null.XQException - if a null uri is specifiedpublic void setDefaultFunctionNamespace(String uri) throws XQException
XQStaticContextsetDefaultFunctionNamespace in interface XQStaticContexturi - the namespace URI of the default function namespace,
the empty string to make it unspecified.
Cannot be null.XQException - if a null URI is specifiedpublic void setDefaultOrderForEmptySequences(int order)
throws XQException
XQStaticContextsetDefaultOrderForEmptySequences in interface XQStaticContextorder - the default order for empty sequences. One of:
XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_GREATEST,
XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_LEAST.XQException - the specified order for empty sequences is different from
XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_GREATEST,
XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_LEASTpublic void setOrderingMode(int mode)
throws XQException
XQStaticContextsetOrderingMode in interface XQStaticContextmode - ordering mode value. One of:
XQConstants.ORDERING_MODE_ORDERED,
XQConstants.ORDERING_MODE_UNORDERED.XQException - the specified mode is different from
XQConstants.ORDERING_MODE_ORDERED,
XQConstants.ORDERING_MODE_UNORDEREDpublic void setQueryTimeout(int seconds)
throws XQException
XQStaticContextsetQueryTimeout in interface XQStaticContextseconds - the query execution timeout value in seconds.
A value of 0 indicates no limitXQException - if the passed in value is negativepublic void setHoldability(int holdability)
throws XQException
XQStaticContextsetHoldability in interface XQStaticContextholdability - the holdability of the result. One of:
XQConstants.HOLDTYPE_HOLD_CURSORS_OVER_COMMIT,
or XQConstants.HOLDTYPE_CLOSE_CURSORS_AT_COMMIT.XQException - the specified holdability is different from
XQConstants.HOLDTYPE_HOLD_CURSORS_OVER_COMMIT,
XQConstants.HOLDTYPE_CLOSE_CURSORS_AT_COMMITpublic void setQueryLanguageTypeAndVersion(int langtype)
throws XQException
XQStaticContextsetQueryLanguageTypeAndVersion in interface XQStaticContextlangtype - the query language type and version of the
inputs. One of: XQConstants.LANGTYPE_XQUERY
(default), or XQConstants.LANGTYPE_XQUERYX.
A negative number indicates a vendor specific
query language type and version.XQException - the specified langtype is different from
XQConstants.LANGTYPE_XQUERY,
XQConstants.LANGTYPE_XQUERYX and is not negativepublic void setScrollability(int scrollability)
throws XQException
XQStaticContextsetScrollability in interface XQStaticContextscrollability - the scrollability of the result. One of:
XQConstants.SCROLLTYPE_FORWARD_ONLY, or
XQConstants.SCROLLTYPE_SCROLLABLE.XQException - the specified crollability type is different from
XQConstants.SCROLLTYPE_FORWARD_ONLY,
XQConstants.SCROLLTYPE_SCROLLABLEprotected void checkNotNull(Object arg) throws XQException
XQExceptionCopyright (c) 2004-2013 Saxonica Limited. All rights reserved.