|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.xqj.SaxonXQStaticContext
public class SaxonXQStaticContext
Saxon implementation of the XQJ XQStaticContext interface
Constructor Summary | |
---|---|
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 |
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SaxonXQStaticContext(Configuration config)
config
- the Saxon configurationpublic SaxonXQStaticContext(SaxonXQStaticContext sc)
sc
- the static context to be copiedMethod Detail |
---|
protected StaticQueryContext getSaxonStaticQueryContext()
public void declareNamespace(String prefix, String uri) throws XQException
XQStaticContext
declareNamespace
in interface XQStaticContext
prefix
- the prefix for the namespace URIuri
- the namespace URI. An empty string
undeclares the specific prefix. Cannot be null
XQException
- if (1) a null
prefix, or (2) a null
namespace
URI is specifiedpublic String getBaseURI()
XQStaticContext
getBaseURI
in interface XQStaticContext
null
..public int getBindingMode()
XQStaticContext
getBindingMode
in interface XQStaticContext
XQConstants.BINDING_MODE_IMMEDIATE
,
orXQConstants.BINDING_MODE_DEFERRED
.public int getBoundarySpacePolicy()
XQStaticContext
getBoundarySpacePolicy
in interface XQStaticContext
XQConstants.BOUNDARY_SPACE_PRESERVE
,
XQConstants.BOUNDARY_SPACE_STRIP
.public int getConstructionMode()
XQStaticContext
getConstructionMode
in interface XQStaticContext
XQConstants.CONSTRUCTION_MODE_PRESERVE
,
XQConstants.CONSTRUCTION_MODE_STRIP
public XQItemType getContextItemStaticType()
XQStaticContext
null
if unspecified.
getContextItemStaticType
in interface XQStaticContext
null
public int getCopyNamespacesModeInherit()
XQStaticContext
getCopyNamespacesModeInherit
in interface XQStaticContext
XQConstants.COPY_NAMESPACES_MODE_INHERIT
,
XQConstants.COPY_NAMESPACES_MODE_NO_INHERIT
.public int getCopyNamespacesModePreserve()
XQStaticContext
getCopyNamespacesModePreserve
in interface XQStaticContext
XQConstants.COPY_NAMESPACES_MODE_PRESERVE
,
XQConstants.COPY_NAMESPACES_MODE_NO_PRESERVE
.public String getDefaultCollation()
XQStaticContext
getDefaultCollation
in interface XQStaticContext
null
.public String getDefaultElementTypeNamespace()
XQStaticContext
getDefaultElementTypeNamespace
in interface XQStaticContext
null
public String getDefaultFunctionNamespace()
XQStaticContext
getDefaultFunctionNamespace
in interface XQStaticContext
null
public int getDefaultOrderForEmptySequences()
XQStaticContext
getDefaultOrderForEmptySequences
in interface XQStaticContext
XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_GREATEST
,
XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_LEAST
.public String[] getNamespacePrefixes()
XQStaticContext
getNamespaceURI
method to look up the namespace URI
corresponding to a specific prefix.
getNamespacePrefixes
in interface XQStaticContext
String
array containing the namespace prefixes.
Cannot be null
public String getNamespaceURI(String prefix) throws XQException
XQStaticContext
XQException
is thrown if an unknown prefix is specified, i.e. a prefix not returned by the
getInScopeNamespacePrefixes
method.
getNamespaceURI
in interface XQStaticContext
prefix
- the prefix for which the namespace URI is sought. Cannot
be null
null
XQException
- if a null
prefix is specified or if the prefix
is unknownpublic int getOrderingMode()
XQStaticContext
getOrderingMode
in interface XQStaticContext
XQConstants.ORDERING_MODE_ORDERED
,
XQConstants.ORDERING_MODE_UNORDERED
.public int getHoldability()
XQStaticContext
getHoldability
in interface XQStaticContext
XQConstants.HOLDTYPE_HOLD_CURSORS_OVER_COMMIT
,
or XQConstants.HOLDTYPE_CLOSE_CURSORS_AT_COMMIT
.public int getQueryLanguageTypeAndVersion()
XQStaticContext
XQConstants.LANGTYPE_XQUERY
.
getQueryLanguageTypeAndVersion
in interface XQStaticContext
XQConstants.LANGTYPE_XQUERY
,
or XQConstants.LANGTYPE_XQUERYX
or a negative value indicating a vendor specific
query language type and version.public int getQueryTimeout()
XQStaticContext
getQueryTimeout
in interface XQStaticContext
public int getScrollability()
XQStaticContext
getScrollability
in interface XQStaticContext
XQConstants.SCROLLTYPE_FORWARD_ONLY
, or
XQConstants.SCROLLTYPE_SCROLLABLE
.public void setBaseURI(String baseUri) throws XQException
XQStaticContext
setBaseURI
in interface XQStaticContext
baseUri
- 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
XQStaticContext
setBindingMode
in interface XQStaticContext
bindingMode
- 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_DEFERRED
public void setBoundarySpacePolicy(int policy) throws XQException
XQStaticContext
setBoundarySpacePolicy
in interface XQStaticContext
policy
- 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_STRIP
public void setConstructionMode(int mode) throws XQException
XQStaticContext
setConstructionMode
in interface XQStaticContext
mode
- 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_STRIP
public void setContextItemStaticType(XQItemType contextItemType)
XQStaticContext
null
to make it unspecified.
setContextItemStaticType
in interface XQStaticContext
contextItemType
- the static type of the context item;
null
if unspecified.public void setCopyNamespacesModeInherit(int mode) throws XQException
XQStaticContext
setCopyNamespacesModeInherit
in interface XQStaticContext
mode
- 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_INHERIT
public void setCopyNamespacesModePreserve(int mode) throws XQException
XQStaticContext
setCopyNamespacesModePreserve
in interface XQStaticContext
mode
- 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_PRESERVE
public void setDefaultCollation(String uri) throws XQException
XQStaticContext
setDefaultCollation
in interface XQStaticContext
uri
- the namespace URI of the default collation.
Cannot be null
.
XQException
- if a null
URI is specifiedpublic void setDefaultElementTypeNamespace(String uri) throws XQException
XQStaticContext
setDefaultElementTypeNamespace
in interface XQStaticContext
uri
- 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
XQStaticContext
setDefaultFunctionNamespace
in interface XQStaticContext
uri
- 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
XQStaticContext
setDefaultOrderForEmptySequences
in interface XQStaticContext
order
- 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_LEAST
public void setOrderingMode(int mode) throws XQException
XQStaticContext
setOrderingMode
in interface XQStaticContext
mode
- 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_UNORDERED
public void setQueryTimeout(int seconds) throws XQException
XQStaticContext
setQueryTimeout
in interface XQStaticContext
seconds
- the query execution timeout value in seconds.
A value of 0 indicates no limit
XQException
- if the passed in value is negativepublic void setHoldability(int holdability) throws XQException
XQStaticContext
setHoldability
in interface XQStaticContext
holdability
- 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_COMMIT
public void setQueryLanguageTypeAndVersion(int langtype) throws XQException
XQStaticContext
setQueryLanguageTypeAndVersion
in interface XQStaticContext
langtype
- 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
XQStaticContext
setScrollability
in interface XQStaticContext
scrollability
- 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_SCROLLABLE
protected void checkNotNull(Object arg) throws XQException
XQException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |