blob: 98c6189915dab8075f8b8b99490e2289b2f3de73 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<jel>
<admin creation="Thu May 19 00:54:27 CEST 2011" xsdversion="1.0.0" version="1.0.0" />
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.AtomicItemType" type="AtomicItemType">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType" />
</implements>
<comment>
<description>Defines an sequence or item of atomic types.</description>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="getTypeDefinition" returncomment="The Schema type of the sequence or item." fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<comment>
<description>Returns the schema type of the sequence or type.</description>
<attribute name="@return">
<description>The Schema type of the sequence or item.</description>
</attribute>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.CollationProvider" type="CollationProvider">
<comment>
<description>Service provider interface for looking up collations from within the
dynamic context.
Definition from the XPath2 specification: A collation is a specification of
the manner in which strings and URIs are compared and, by extension,
ordered. For a more complete definition of collation, see [XQuery 1.0 and
XPath 2.0 Functions and Operators (Second Edition)].</description>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<fields>
<field final="true" static="true" const="http://www.w3.org/2005/xpath-functions/collation/codepoint" visibility="public" name="CODEPOINT_COLLATION" constexpr="&quot;http://www.w3.org/2005/xpath-functions/collation/codepoint&quot;" fulltype="java.lang.String" type="String">
<comment>
<description>The default collation which is guaranteed to always be implemented</description>
</comment>
</field>
</fields>
<methods>
<method visibility="public" name="getCollation" returncomment="The collation to use, or null if no such collation exists by
this provider" fulltype="java.util.Comparator" type="Comparator">
<comment>
<description>Gets the named collator. W3C does not define collation names (yet?) so
we are constrained to using an implementation-defined naming scheme.</description>
<attribute name="@param">
<description>name
A URI designating the collation to use</description>
</attribute>
<attribute name="@return">
<description>The collation to use, or null if no such collation exists by
this provider</description>
</attribute>
</comment>
<params>
<param name="name" comment="A URI designating the collation to use" fulltype="java.lang.String" type="String" />
</params>
</method>
<method visibility="public" name="getDefaultCollation" fulltype="java.lang.String" type="String" />
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.DynamicContext" type="DynamicContext">
<comment>
<description>Interface for dynamic context. This covers the Dynamic Context as defined by the XPath2 specification, EXCEPT for
context item and size (handled in EvaluationContext)</description>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="getLimitNode" returncomment="DOM node which limits axis navigation." fulltype="org.w3c.dom.Node" type="Node">
<comment>
<description>Returns a &quot;top&quot; node which the XPath2 engine is not allowed to
leave</description>
<attribute name="@return">
<description>DOM node which limits axis navigation.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getVariable" returncomment="variable." fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence">
<comment>
<description>Get variable.</description>
<attribute name="@param">
<description>name
is the name of the variable.</description>
</attribute>
<attribute name="@return">
<description>variable.</description>
</attribute>
</comment>
<params>
<param name="name" comment="is the name of the variable." fulltype="javax.xml.namespace.QName" type="QName" />
</params>
</method>
<method visibility="public" name="resolveUri" returncomment="the absolutized, resolved URI." fulltype="java.net.URI" type="URI">
<comment>
<description>Resolve an URI</description>
<attribute name="@param">
<description>uri
is the possibly relative URI to resolve</description>
</attribute>
<attribute name="@return">
<description>the absolutized, resolved URI.</description>
</attribute>
</comment>
<params>
<param name="uri" comment="is the possibly relative URI to resolve" fulltype="java.lang.String" type="String" />
</params>
</method>
<method visibility="public" name="getCurrentDateTime" returncomment="The current date and time, which will always be same for the dynamic context." fulltype="java.util.GregorianCalendar" type="GregorianCalendar">
<comment>
<description>[Definition: Current dateTime. This
information represents an implementation-dependent point in time during
the processing of an expression, and includes an explicit timezone. It
can be retrieved by the fn:current-dateTime function. If invoked
multiple times during the execution of an expression, this function
always returns the same result.]
Returns the current date time using the GregorianCalendar.</description>
<attribute name="@return">
<description>The current date and time, which will always be same for the dynamic context.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getTimezoneOffset" returncomment="current date time and implicit timezone." fulltype="javax.xml.datatype.Duration" type="Duration">
<comment>
<description>[Definition: Implicit timezone. This
is the timezone to be used when a date, time, or dateTime value that
does not have a timezone is used in a comparison or arithmetic
operation. The implicit timezone is an implementation-defined value of
type xs:dayTimeDuration. See [XML Schema] for the range of legal values
of a timezone.]</description>
<attribute name="@return">
<description>current date time and implicit timezone.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getDocument" returncomment="document." fulltype="org.w3c.dom.Document" type="Document">
<comment>
<description>[Definition: Available documents. This is a mapping of
strings onto document nodes. The string represents the absolute URI of
a resource. The document node is the root of a tree that represents
that resource using the data model. The document node is returned by
the fn:doc function when applied to that URI.] The set of available
documents is not limited to the set of statically known documents, and
it may be empty. If there are one or more URIs in available documents
that map to a document node D, then the document-uri property of D must
either be absent, or must be one of these URIs. Note: This means that
given a document node $N, the result of fn:doc(fn:document-uri($N)) is
$N will always be True, unless fn:document-uri($N) is an empty
sequence.</description>
<attribute name="@param">
<description>uri
is the URI of the document.</description>
</attribute>
<attribute name="@return">
<description>document.</description>
</attribute>
</comment>
<params>
<param name="uri" comment="is the URI of the document." fulltype="java.net.URI" type="URI" />
</params>
</method>
<method visibility="public" name="getCollections" fulltype="java.util.Map" type="Map">
<comment>
<description>[Definition: Available collections. This is a mapping of
strings onto sequences of nodes. The string represents the absolute URI
of a resource. The sequence of nodes represents the result of the
fn:collection function when that URI is supplied as the argument. ] The
set of available collections is not limited to the set of statically
known collections, and it may be empty. For every document node D that
is in the target of a mapping in available collections, or that is the
root of a tree containing such a node, the document-uri property of D
must either be absent, or must be a URI U such that available documents
contains a mapping from U to D.&quot; Note: This means that for any document
node $N retrieved using the fn:collection function, either directly or
by navigating to the root of a node that was returned, the result of
fn:doc(fn:document-uri($N)) is $N will always be True, unless
fn:document-uri($N) is an empty sequence. This implies a requirement
for the fn:doc and fn:collection functions to be consistent in their
effect. If the implementation uses catalogs or user-supplied URI
resolvers to dereference URIs supplied to the fn:doc function, the
implementation of the fn:collection function must take these mechanisms
into account. For example, an implementation might achieve this by
mapping the collection URI to a set of document URIs, which are then
resolved using the same catalog or URI resolver that is used by the
fn:doc function.</description>
</comment>
</method>
<method visibility="public" name="getDefaultCollection" fulltype="java.util.List" type="List">
<comment>
<description>[Definition: Default collection. This is the sequence
of nodes that would result from calling the fn:collection function with
no arguments.] The value of default collection may be initialized by
the implementation.</description>
</comment>
</method>
<method visibility="public" name="getCollationProvider" fulltype="org.eclipse.wst.xml.xpath2.api.CollationProvider" type="CollationProvider">
<comment>
<description>Actual collation providers available for use dynamically. This could
differ from the collations available statically, but would give
unexpected results.</description>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.EvaluationContext" type="EvaluationContext">
<comment>
<attribute name="@noimplement">
<description>This interface is not intended to be implemented by clients.</description>
</attribute>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="getContextItem" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<comment>
<description>Definition: The context item is the item currently being processed. An
item is either an atomic value or a node.
Definition: When the context
item is a node, it can also be referred to as the context node.
The
context item is returned by an expression consisting of a single dot
(.). When an expression E1/E2 or E1[E2] is evaluated, each item in the
sequence obtained by evaluating E1 becomes the context item in the
inner focus for an evaluation of E2.</description>
</comment>
</method>
<method visibility="public" name="getContextPosition" fulltype="int" type="int">
<comment>
<description>[Definition: The context position
is the position of the context item within the sequence of items
currently being processed.] It changes whenever the context item
changes. When the focus is defined, the value of the context position
is an integer greater than zero. The context position is returned by
the expression fn:position(). When an expression E1/E2 or E1[E2] is
evaluated, the context position in the inner focus for an evaluation of
E2 is the position of the context item in the sequence obtained by
evaluating E1. The position of the first item in a sequence is always 1
(one). The context position is always less than or equal to the context
size.</description>
</comment>
</method>
<method visibility="public" name="getLastPosition" fulltype="int" type="int">
<comment>
<description>[Definition: The context size is the number of items in the
sequence of items currently being processed.] Its value is always an
integer greater than zero. The context size is returned by the
expression fn:last(). When an expression E1/E2 or E1[E2] is evaluated,
the context size in the inner focus for an evaluation of E2 is the
number of items in the sequence obtained by evaluating E1. [Definition:
Variable values. This is a set of (expanded QName, value) pairs. It
contains the same expanded QNames as the in-scope variables in the
static context for the expression. The expanded QName is the name of
the variable and the value is the dynamic value of the variable, which
includes its dynamic type.]</description>
</comment>
</method>
<method visibility="public" name="getDynamicContext" returncomment="The current dynamic context in effect." fulltype="org.eclipse.wst.xml.xpath2.api.DynamicContext" type="DynamicContext">
<comment>
<attribute name="@return">
<description>The current dynamic context in effect.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getStaticContext" returncomment="The current static context in effect." fulltype="org.eclipse.wst.xml.xpath2.api.StaticContext" type="StaticContext">
<comment>
<attribute name="@return">
<description>The current static context in effect.</description>
</attribute>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.Function" type="Function">
<comment>
<description>Support for functions.</description>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="getName" returncomment="Result of QName operation." fulltype="java.lang.String" type="String">
<comment>
<description>Support for QName interface.</description>
<attribute name="@return">
<description>Result of QName operation.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getMinArity" returncomment="The smallest number of arguments possible" fulltype="int" type="int">
<comment>
<description>Minimal number of allowed arguments.</description>
<attribute name="@return">
<description>The smallest number of arguments possible</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getMaxArity" returncomment="The highest number of arguments possible" fulltype="int" type="int">
<comment>
<description>Maximum number of allowed arguments.</description>
<attribute name="@return">
<description>The highest number of arguments possible</description>
</attribute>
</comment>
</method>
<method visibility="public" name="isVariableArgument" returncomment="The highest number of arguments possible" fulltype="boolean" type="boolean">
<comment>
<description>Maximum number of allowed arguments.</description>
<attribute name="@return">
<description>The highest number of arguments possible</description>
</attribute>
</comment>
</method>
<method visibility="public" name="canMatchArity" returncomment="" fulltype="boolean" type="boolean">
<comment>
<description>Checks if this function has an to the</description>
<attribute name="@param">
<description>actual_arity</description>
</attribute>
<attribute name="@return" />
</comment>
<params>
<param name="actualArity" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="getResultType" returncomment="TypeDefinition for the argument" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<comment>
<description>Gets the return type for the function.</description>
<attribute name="@return">
<description>TypeDefinition for the argument</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getArgumentType" returncomment="TypeDefinition for the argument" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<comment>
<description>Returns the type of the argument at position index,
starting at 0.</description>
<attribute name="@return">
<description>TypeDefinition for the argument</description>
</attribute>
</comment>
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="getArgumentNameHint" returncomment="TypeDefinition for the argument" fulltype="java.lang.String" type="String">
<comment>
<description>Name hint for the index&apos;th argument,
starting at 0.</description>
<attribute name="@return">
<description>TypeDefinition for the argument</description>
</attribute>
</comment>
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="evaluate" returncomment="Result of evaluation." fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence">
<comment>
<description>Evaluate arguments.</description>
<attribute name="@param">
<description>args
argument expressions.</description>
</attribute>
<attribute name="@return">
<description>Result of evaluation.</description>
</attribute>
</comment>
<params>
<param name="args" comment="argument expressions." fulltype="java.util.Collection" type="Collection" />
<param name="evaluationContext" fulltype="org.eclipse.wst.xml.xpath2.api.EvaluationContext" type="EvaluationContext" />
</params>
</method>
<method visibility="public" name="computeReturnType" returncomment="Result of evaluation." fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<comment>
<description>Evaluate the exact result type.</description>
<attribute name="@param">
<description>args
argument expressions.</description>
</attribute>
<attribute name="@return">
<description>Result of evaluation.</description>
</attribute>
</comment>
<params>
<param name="args" comment="argument expressions." fulltype="java.util.Collection" type="Collection" />
<param name="sc" fulltype="org.eclipse.wst.xml.xpath2.api.StaticContext" type="StaticContext" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.FunctionLibrary" type="FunctionLibrary">
<comment>
<description>Interface for function libraries support.</description>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<fields>
<field final="true" static="true" const="2147483647" visibility="public" name="VARIABLE_ARITY" constexpr="2147483647" fulltype="int" type="int" />
</fields>
<methods>
<method visibility="public" name="functionExists" returncomment="Result of the test." fulltype="boolean" type="boolean">
<comment>
<description>Checks whether the function exists or not.</description>
<attribute name="@param">
<description>name
Name of function.</description>
</attribute>
<attribute name="@param">
<description>arity
arity of the function,</description>
</attribute>
<attribute name="@return">
<description>Result of the test.</description>
</attribute>
</comment>
<params>
<param name="name" comment="Name of function." fulltype="java.lang.String" type="String" />
<param name="arity" comment="arity of the function," fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="resolveFunction" returncomment="The function from the library." fulltype="org.eclipse.wst.xml.xpath2.api.Function" type="Function">
<comment>
<description>Function support.</description>
<attribute name="@param">
<description>name
local name .</description>
</attribute>
<attribute name="@param">
<description>arity
arity of the function.</description>
</attribute>
<attribute name="@return">
<description>The function from the library.</description>
</attribute>
</comment>
<params>
<param name="localName" fulltype="java.lang.String" type="String" />
<param name="arity" comment="arity of the function." fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="getNamespace" returncomment="Namespace." fulltype="java.lang.String" type="String">
<comment>
<description>Returns the namespace of the function library.</description>
<attribute name="@return">
<description>Namespace.</description>
</attribute>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<comment>
<description>An item in the XPath2 data model</description>
<attribute name="@since">
<description>2.0</description>
</attribute>
<attribute name="@noimplement">
<description>This interface is not intended to be implemented by clients.</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="getItemType" returncomment="A description of the item type." fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<comment>
<attribute name="@return">
<description>A description of the item type.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getNativeValue" returncomment="The &quot;Raw&quot; Java object, e.g. org.w3.Node for a node,
java.util.String for strings, etc." fulltype="java.lang.Object" type="Object">
<comment>
<attribute name="@return">
<description>The &quot;Raw&quot; Java object, e.g. org.w3.Node for a node,
java.util.String for strings, etc.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getStringValue" fulltype="java.lang.String" type="String" />
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.Match" type="Match">
<comment>
<description>A match found by the XPath2 pattern matcher
* @noimplement This interface is not intended to be implemented by clients.</description>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="getMatchingCount" returncomment="The number of matching patterns on the input." fulltype="int" type="int">
<comment>
<attribute name="@return">
<description>The number of matching patterns on the input.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getBestMatch" returncomment="Pattern which was the best match." fulltype="org.eclipse.wst.xml.xpath2.api.XPath2Pattern" type="XPath2Pattern">
<comment>
<description>Returns the XPath2 pattern which best matched the input (considering mode and priority)</description>
<attribute name="@return">
<description>Pattern which was the best match.</description>
</attribute>
</comment>
</method>
</methods>
</jelclass>
<jelclass superclass="Object" visibility="public" package="org.eclipse.wst.xml.xpath2.api" superclassfulltype="java.lang.Object" fulltype="org.eclipse.wst.xml.xpath2.api.ResultBuffer" type="ResultBuffer">
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<fields>
<field final="true" static="true" visibility="public" name="EMPTY" fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence" />
</fields>
<methods>
<constructor visibility="public" name="ResultBuffer" />
<method visibility="public" name="getSequence" fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence" />
<method visibility="public" name="clear" fulltype="void" type="void" />
<method visibility="public" name="add" fulltype="org.eclipse.wst.xml.xpath2.api.ResultBuffer" type="ResultBuffer">
<params>
<param name="at" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
</params>
</method>
<method visibility="public" name="append" fulltype="org.eclipse.wst.xml.xpath2.api.ResultBuffer" type="ResultBuffer">
<params>
<param name="at" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
</params>
</method>
<method visibility="public" name="concat" fulltype="org.eclipse.wst.xml.xpath2.api.ResultBuffer" type="ResultBuffer">
<params>
<param name="rs" fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence" />
</params>
</method>
<method visibility="public" name="size" fulltype="int" type="int" />
<method visibility="public" name="iterator" fulltype="java.util.ListIterator" type="ListIterator" />
<method visibility="public" name="prepend" fulltype="void" type="void">
<params>
<param name="rs" fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence" />
</params>
</method>
<method visibility="public" name="getCollection" fulltype="java.util.Collection" type="Collection" />
<method visibility="public" name="concat" fulltype="org.eclipse.wst.xml.xpath2.api.ResultBuffer" type="ResultBuffer">
<params>
<param name="others" fulltype="java.util.Collection" type="Collection" />
</params>
</method>
<method static="true" visibility="public" name="wrap" fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence">
<params>
<param name="item" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
</params>
</method>
<method visibility="public" name="item" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="addAt" fulltype="void" type="void">
<params>
<param name="pos" fulltype="int" type="int" />
<param name="element" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
</params>
</method>
</methods>
<jelclass final="true" superclass="Object" visibility="public" package="org.eclipse.wst.xml.xpath2.api" superclassfulltype="java.lang.Object" fulltype="org.eclipse.wst.xml.xpath2.api.ResultBuffer.SingleResultSequence" type="ResultBuffer.SingleResultSequence">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence" />
</implements>
<methods>
<constructor visibility="public" name="ResultBuffer.SingleResultSequence">
<params>
<param name="at" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
</params>
</constructor>
<method visibility="public" name="size" fulltype="int" type="int" />
<method visibility="public" name="item" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="first" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
<method visibility="public" name="value" fulltype="java.lang.Object" type="Object">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="empty" fulltype="boolean" type="boolean" />
<method visibility="public" name="firstValue" fulltype="java.lang.Object" type="Object" />
<method visibility="public" name="iterator" fulltype="java.util.Iterator" type="Iterator" />
<method visibility="public" name="itemType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="sequenceType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType" />
</methods>
</jelclass>
<jelclass final="true" superclass="Object" visibility="public" package="org.eclipse.wst.xml.xpath2.api" superclassfulltype="java.lang.Object" fulltype="org.eclipse.wst.xml.xpath2.api.ResultBuffer.ArrayResultSequence" type="ResultBuffer.ArrayResultSequence">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence" />
</implements>
<methods>
<constructor visibility="public" name="ResultBuffer.ArrayResultSequence">
<params>
<param name="results" fulltype="org.eclipse.wst.xml.xpath2.api.Item[]" type="Item" />
</params>
</constructor>
<method visibility="public" name="size" fulltype="int" type="int" />
<method visibility="public" name="item" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="empty" fulltype="boolean" type="boolean" />
<method visibility="public" name="firstValue" fulltype="java.lang.Object" type="Object" />
<method visibility="public" name="first" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
<method visibility="public" name="iterator" fulltype="java.util.Iterator" type="Iterator" />
<method visibility="public" name="itemType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="sequenceType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType" />
<method visibility="public" name="value" fulltype="java.lang.Object" type="Object">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
</methods>
</jelclass>
</jelclass>
<jelclass final="true" superclass="Object" visibility="public" package="org.eclipse.wst.xml.xpath2.api" superclassfulltype="java.lang.Object" fulltype="org.eclipse.wst.xml.xpath2.api.ResultBuffer.SingleResultSequence" type="ResultBuffer.SingleResultSequence">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence" />
</implements>
<methods>
<constructor visibility="public" name="ResultBuffer.SingleResultSequence">
<params>
<param name="at" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
</params>
</constructor>
<method visibility="public" name="size" fulltype="int" type="int" />
<method visibility="public" name="item" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="first" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
<method visibility="public" name="value" fulltype="java.lang.Object" type="Object">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="empty" fulltype="boolean" type="boolean" />
<method visibility="public" name="firstValue" fulltype="java.lang.Object" type="Object" />
<method visibility="public" name="iterator" fulltype="java.util.Iterator" type="Iterator" />
<method visibility="public" name="itemType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="sequenceType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType" />
</methods>
</jelclass>
<jelclass final="true" superclass="Object" visibility="public" package="org.eclipse.wst.xml.xpath2.api" superclassfulltype="java.lang.Object" fulltype="org.eclipse.wst.xml.xpath2.api.ResultBuffer.ArrayResultSequence" type="ResultBuffer.ArrayResultSequence">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence" />
</implements>
<methods>
<constructor visibility="public" name="ResultBuffer.ArrayResultSequence">
<params>
<param name="results" fulltype="org.eclipse.wst.xml.xpath2.api.Item[]" type="Item" />
</params>
</constructor>
<method visibility="public" name="size" fulltype="int" type="int" />
<method visibility="public" name="item" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="empty" fulltype="boolean" type="boolean" />
<method visibility="public" name="firstValue" fulltype="java.lang.Object" type="Object" />
<method visibility="public" name="first" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item" />
<method visibility="public" name="iterator" fulltype="java.util.Iterator" type="Iterator" />
<method visibility="public" name="itemType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="sequenceType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType" />
<method visibility="public" name="value" fulltype="java.lang.Object" type="Object">
<params>
<param name="index" fulltype="int" type="int" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence">
<comment>
<description>Immutable representation of a result</description>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="size" returncomment="Count of items." fulltype="int" type="int">
<comment>
<description>Return the size of the result set. Only call this if you need it, since it may require that the entire result
is fetched.</description>
<attribute name="@return">
<description>Count of items.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="value" returncomment="Native object representing the item." fulltype="java.lang.Object" type="Object">
<comment>
<description>Return the native representation of the item.</description>
<attribute name="@param">
<description>index</description>
</attribute>
<attribute name="@return">
<description>Native object representing the item.</description>
</attribute>
</comment>
<params>
<param name="index" comment="" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="item" returncomment="Native object representing the item." fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<comment>
<description>Return the item.</description>
<attribute name="@param">
<description>index</description>
</attribute>
<attribute name="@return">
<description>Native object representing the item.</description>
</attribute>
</comment>
<params>
<param name="index" comment="" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="firstValue" returncomment="Native object representing the first item." fulltype="java.lang.Object" type="Object">
<comment>
<description>Return the native representation of the first item.</description>
<attribute name="@return">
<description>Native object representing the first item.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="itemType" returncomment="" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<comment>
<description>XPath2 type definition description of the item at location &apos;0&apos;</description>
<attribute name="@param">
<description>index</description>
</attribute>
<attribute name="@return" />
</comment>
<params>
<param name="index" comment="" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="empty" returncomment="true for empty sequences" fulltype="boolean" type="boolean">
<comment>
<description>Is the sequence empty.</description>
<attribute name="@return">
<description>true for empty sequences</description>
</attribute>
</comment>
</method>
<method visibility="public" name="iterator" returncomment="" fulltype="java.util.Iterator" type="Iterator">
<comment>
<description>Iterator of Item elements</description>
<attribute name="@return" />
</comment>
</method>
<method visibility="public" name="first" returncomment="" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<comment>
<attribute name="@return" />
</comment>
</method>
<method visibility="public" name="sequenceType" returncomment="Item type definition." fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<comment>
<description>Describe the whole sequence&apos;s type.</description>
<attribute name="@return">
<description>Item type definition.</description>
</attribute>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.StaticContext" type="StaticContext">
<comment>
<description>interface to static context</description>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="isXPath1Compatible" returncomment="true if rules for backward compatibility with XPath Version 1.0
are in effect; otherwise false." fulltype="boolean" type="boolean">
<comment>
<description>XPath 1.0 compatibility mode.</description>
<attribute name="@return">
<description>true if rules for backward compatibility with XPath Version 1.0
are in effect; otherwise false.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getInScopeVariables" fulltype="org.eclipse.wst.xml.xpath2.api.StaticVariableResolver" type="StaticVariableResolver">
<comment>
<description>[Definition: In-scope variables. This is a set of (expanded QName,
type) pairs. It defines the set of variables that are available for
reference within an expression. The expanded QName is the name of the
variable, and the type is the static type of the variable.] An
expression that binds a variable (such as a for, some, or every
expression) extends the in-scope variables of its subexpressions with
the new bound variable and its type.</description>
</comment>
</method>
<method visibility="public" name="getInitialContextType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<comment>
<description>[Definition: Context item static type. This component defines the
static type of the context item within the scope of a given
expression.]</description>
</comment>
</method>
<method visibility="public" name="getFunctionLibraries" fulltype="java.util.Map" type="Map">
<comment>
<description>[Definition: Function signatures. This component defines the set of
functions that are available to be called from within an expression.
Each function is uniquely identified by its expanded QName and its
arity (number of parameters).] In addition to the name and arity, each
function signature specifies the static types of the function
parameters and result. The function signatures include the signatures
of constructor functions, which are discussed in 3.10.4 Constructor
Functions.</description>
</comment>
</method>
<method visibility="public" name="getCollationProvider" fulltype="org.eclipse.wst.xml.xpath2.api.CollationProvider" type="CollationProvider">
<comment>
<description>[Definition: Statically known collations. This is an
implementation-defined set of (URI, collation) pairs. It defines the
names of the collations that are available for use in processing
expressions.]</description>
</comment>
</method>
<method visibility="public" name="getBaseUri" fulltype="java.net.URI" type="URI">
<comment>
<description>[Definition: Base URI. This is an absolute URI, used when necessary in
the resolution of relative URIs (for example, by the fn:resolve-uri
function.)] The URI value is whitespace normalized according to the
rules for the xs:anyURI type in [XML Schema].</description>
</comment>
</method>
<method visibility="public" name="getDocumentType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<comment>
<description>[Definition: Statically known documents. This is a mapping from strings
onto types. The string represents the absolute URI of a resource that
is potentially available using the fn:doc function. The type is the
static type of a call to fn:doc with the given URI as its literal
argument. ] If the argument to fn:doc is a string literal that is not
present in statically known documents, then the static type of fn:doc
is document-node()?. Note: The purpose of the statically known
documents is to provide static type information, not to determine which
documents are available. A URI need not be found in the statically
known documents to be accessed using fn:doc.</description>
</comment>
<params>
<param name="documentUri" fulltype="java.net.URI" type="URI" />
</params>
</method>
<method visibility="public" name="getNamespaceContext" returncomment="The statically known namespace context" fulltype="javax.xml.namespace.NamespaceContext" type="NamespaceContext">
<comment>
<description>[Definition: Statically known namespaces. This is a set of (prefix,
URI) pairs that define all the namespaces that are known during static
processing of a given expression.] The URI value is whitespace
normalized according to the rules for the xs:anyURI type in [XML
Schema]. Note the difference between in-scope namespaces, which is a
dynamic property of an element node, and statically known namespaces,
which is a static property of an expression.</description>
<attribute name="@return">
<description>The statically known namespace context</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getDefaultNamespace" returncomment="" fulltype="java.lang.String" type="String">
<comment>
<description>[Definition: Default element/type namespace. This is a namespace URI or
&quot;none&quot;. The namespace URI, if present, is used for any unprefixed QName
appearing in a position where an element or type name is expected.] The
URI value is whitespace normalized according to the rules for the
xs:anyURI type in [XML Schema].</description>
<attribute name="@return" />
</comment>
</method>
<method visibility="public" name="getDefaultFunctionNamespace" returncomment="The default function namespace" fulltype="java.lang.String" type="String">
<comment>
<description>Definition: Default function namespace. This is a namespace URI or
&quot;none&quot;. The namespace URI, if present, is used for any unprefixed QName
appearing in a position where a function name is expected.] The URI
value is whitespace normalized according to the rules for the xs:anyURI
type in [XML Schema].</description>
<attribute name="@return">
<description>The default function namespace</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getTypeModel" returncomment="A type model which covers the" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeModel" type="TypeModel">
<comment>
<description>[Definition: In-scope schema definitions. This is a generic term for
all the element declarations, attribute declarations, and schema type
definitions that are in scope during processing of an expression.]</description>
<attribute name="@return">
<description>A type model which covers the</description>
</attribute>
</comment>
</method>
<method visibility="public" name="resolveFunction" returncomment="boolean" fulltype="org.eclipse.wst.xml.xpath2.api.Function" type="Function">
<comment>
<description>is the function declared/available in the source context?</description>
<attribute name="@param">
<description>name
is the qname name</description>
</attribute>
<attribute name="@param">
<description>arity
integer of qname</description>
</attribute>
<attribute name="@return">
<description>boolean</description>
</attribute>
</comment>
<params>
<param name="name" comment="is the qname name" fulltype="javax.xml.namespace.QName" type="QName" />
<param name="arity" comment="integer of qname" fulltype="int" type="int" />
</params>
</method>
<method visibility="public" name="getCollectionType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<comment>
<description>[Definition: Statically known collections. This is a mapping from
strings onto types. The string represents the absolute URI of a
resource that is potentially available using the fn:collection
function. The type is the type of the sequence of nodes that would
result from calling the fn:collection function with this URI as its
argument.] If the argument to fn:collection is a string literal that is
not present in statically known collections, then the static type of
fn:collection is node()*. Note: The purpose of the statically known
collections is to provide static type information, not to determine
which collections are available. A URI need not be found in the
statically known collections to be accessed using fn:collection.</description>
</comment>
<params>
<param name="collectionName" fulltype="java.lang.String" type="String" />
</params>
</method>
<method visibility="public" name="getDefaultCollectionType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<comment>
<description>[Definition: Statically known default collection type. This is the type
of the sequence of nodes that would result from calling the
fn:collection function with no arguments.] Unless initialized to some
other value by an implementation, the value of statically known default
collection type is node()*.</description>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.StaticVariableResolver" type="StaticVariableResolver">
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="isVariablePresent" returncomment="Availability of the variable" fulltype="boolean" type="boolean">
<comment>
<description>Is the variable present in the current context.</description>
<attribute name="@param">
<description>name Variable name</description>
</attribute>
<attribute name="@return">
<description>Availability of the variable</description>
</attribute>
</comment>
<params>
<param name="name" comment="Variable name" fulltype="javax.xml.namespace.QName" type="QName" />
</params>
</method>
<method visibility="public" name="getVariableType" returncomment="" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<comment>
<attribute name="@param">
<description>name</description>
</attribute>
<attribute name="@return" />
</comment>
<params>
<param name="name" comment="" fulltype="javax.xml.namespace.QName" type="QName" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.XPath2Engine" type="XPath2Engine">
<comment>
<description>Main API for the XPath2 processor.</description>
<attribute name="@noimplement">
<description>This interface is not intended to be implemented by clients.</description>
</attribute>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="parseExpression" returncomment="A compiled expression." fulltype="org.eclipse.wst.xml.xpath2.api.XPath2Expression" type="XPath2Expression">
<comment>
<description>Parse a full XPath2 expression and type check it against the static context
(if it provides a type model to check against)</description>
<attribute name="@param">
<description>expression String representation of XPath2 expression</description>
</attribute>
<attribute name="@param">
<description>context Static context for the expression.</description>
</attribute>
<attribute name="@return">
<description>A compiled expression.</description>
</attribute>
</comment>
<params>
<param name="expression" comment="String representation of XPath2 expression" fulltype="java.lang.String" type="String" />
<param name="context" comment="Static context for the expression." fulltype="org.eclipse.wst.xml.xpath2.api.StaticContext" type="StaticContext" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.XPath2Expression" type="XPath2Expression">
<comment>
<description>This interface represents a parsed and statically bound XPath2 expression.</description>
<attribute name="@noimplement">
<description>This interface is not intended to be implemented by clients.</description>
</attribute>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="getFreeVariables" returncomment="A Collection containing javax.xml.namespacing.QName of free variables" fulltype="java.util.Collection" type="Collection">
<comment>
<description>Return a collections of QNames of the names of free variables referenced in the XPath expression.
These variables may be requested during evaluation.</description>
<attribute name="@return">
<description>A Collection containing javax.xml.namespacing.QName of free variables</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getResolvedFunctions" returncomment="A Collection containing javax.xml.namespacing.QName of functions in use." fulltype="java.util.Collection" type="Collection">
<comment>
<description>Return a collections of the functions used in the XPath2 expression.</description>
<attribute name="@return">
<description>A Collection containing javax.xml.namespacing.QName of functions in use.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getAxes" returncomment="A Collection containing Strings with the axis names in use." fulltype="java.util.Collection" type="Collection">
<comment>
<description>Return a collections of the axis used in the XPath2 expression.</description>
<attribute name="@return">
<description>A Collection containing Strings with the axis names in use.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="isRootPathUsed" returncomment="true if the expression uses / or //, false otherwise." fulltype="boolean" type="boolean">
<comment>
<description>Whether or not the root path is in use in the XPath2 expression.</description>
<attribute name="@return">
<description>true if the expression uses / or //, false otherwise.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="evaluate" returncomment="A ResultSequence" fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence">
<comment>
<description>Evaluate the XPath2 expression, using the supplied DynamicContext.</description>
<attribute name="@param">
<description>dynamicContext Dynamic context for the expression.</description>
</attribute>
<attribute name="@param">
<description>contextItems Context item (typically nodes, often one) to evaluate under.</description>
</attribute>
<attribute name="@return">
<description>A ResultSequence</description>
</attribute>
</comment>
<params>
<param name="dynamicContext" comment="Dynamic context for the expression." fulltype="org.eclipse.wst.xml.xpath2.api.DynamicContext" type="DynamicContext" />
<param name="contextItems" comment="Context item (typically nodes, often one) to evaluate under." fulltype="java.lang.Object[]" type="Object" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.XPath2Pattern" type="XPath2Pattern">
<comment>
<description>This is a compiled pattern (which is a simpler version of an expression, used to match in XSLT files, etc.)</description>
<attribute name="@noimplement">
<description>This interface is not intended to be implemented by clients.</description>
</attribute>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="getUserData" returncomment="The object passed in my the caller when the patten was created." fulltype="java.lang.Object" type="Object">
<comment>
<attribute name="@return">
<description>The object passed in my the caller when the patten was created.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="matches" fulltype="boolean" type="boolean">
<params>
<param name="dc" fulltype="org.eclipse.wst.xml.xpath2.api.DynamicContext" type="DynamicContext" />
<param name="context" fulltype="org.w3c.dom.Node" type="Node" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.XPath2PatternSet" type="XPath2PatternSet">
<comment>
<attribute name="@noimplement">
<description>This interface is not intended to be implemented by clients.</description>
</attribute>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="compilePattern" fulltype="org.eclipse.wst.xml.xpath2.api.XPath2Pattern" type="XPath2Pattern">
<params>
<param name="context" fulltype="org.eclipse.wst.xml.xpath2.api.StaticContext" type="StaticContext" />
<param name="pattern" fulltype="java.lang.String" type="String" />
<param name="mode" fulltype="java.lang.String" type="String" />
<param name="priority" fulltype="int" type="int" />
<param name="userData" fulltype="java.lang.Object" type="Object" />
</params>
</method>
<method visibility="public" name="removePattern" fulltype="void" type="void">
<params>
<param name="pattern" fulltype="org.eclipse.wst.xml.xpath2.api.XPath2Pattern" type="XPath2Pattern" />
</params>
</method>
<method visibility="public" name="clear" fulltype="void" type="void" />
<method visibility="public" name="match" fulltype="org.eclipse.wst.xml.xpath2.api.Match" type="Match">
<params>
<param name="dc" fulltype="org.eclipse.wst.xml.xpath2.api.DynamicContext" type="DynamicContext" />
<param name="context" fulltype="org.w3c.dom.Node" type="Node" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api.typesystem" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ComplexTypeDefinition" type="ComplexTypeDefinition">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition" />
</implements>
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<fields>
<field final="true" static="true" const="0" visibility="public" name="CONTENT_EMPTY" constexpr="0" fulltype="short" type="short">
<comment>
<description>Represents an empty content type. A content type with the distinguished
value empty validates elements with no character or element
information item children.</description>
</comment>
</field>
<field final="true" static="true" const="1" visibility="public" name="CONTENT_SIMPLE" constexpr="1" fulltype="short" type="short">
<comment>
<description>Represents a simple content type. A content type which is simple
validates elements with character-only children.</description>
</comment>
</field>
<field final="true" static="true" const="2" visibility="public" name="CONTENT_ELEMENT" constexpr="2" fulltype="short" type="short">
<comment>
<description>Represents an element-only content type. An element-only content type
validates elements with children that conform to the supplied content
model.</description>
</comment>
</field>
<field final="true" static="true" const="3" visibility="public" name="CONTENT_MIXED" constexpr="3" fulltype="short" type="short">
<comment>
<description>Represents a mixed content type.</description>
</comment>
</field>
</fields>
<methods>
<method visibility="public" name="getDerivationMethod" fulltype="short" type="short">
<comment>
<description>[derivation method]: either &lt;code&gt;DERIVATION_EXTENSION&lt;/code&gt;,
&lt;code&gt;DERIVATION_RESTRICTION&lt;/code&gt;, or &lt;code&gt;DERIVATION_NONE&lt;/code&gt;
(see &lt;code&gt;XSConstants&lt;/code&gt;).</description>
</comment>
</method>
<method visibility="public" name="getAbstract" fulltype="boolean" type="boolean">
<comment>
<description>[abstract]: a boolean. Complex types for which &lt;code&gt;abstract&lt;/code&gt; is
true must not be used as the type definition for the validation of
element information items.</description>
</comment>
</method>
<method visibility="public" name="getContentType" fulltype="short" type="short">
<comment>
<description>[content type]: one of empty (&lt;code&gt;CONTENTTYPE_EMPTY&lt;/code&gt;), a simple
type definition (&lt;code&gt;CONTENTTYPE_SIMPLE&lt;/code&gt;), mixed (
&lt;code&gt;CONTENTTYPE_MIXED&lt;/code&gt;), or element-only (
&lt;code&gt;CONTENTTYPE_ELEMENT&lt;/code&gt;).</description>
</comment>
</method>
<method visibility="public" name="getSimpleType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.SimpleTypeDefinition" type="SimpleTypeDefinition">
<comment>
<description>A simple type definition corresponding to a simple content model,
otherwise &lt;code&gt;null&lt;/code&gt;.</description>
</comment>
</method>
<method visibility="public" name="isProhibitedSubstitution" returncomment="True if &lt;code&gt;restriction&lt;/code&gt; is a prohibited substitution,
otherwise false." fulltype="boolean" type="boolean">
<comment>
<description>[prohibited substitutions]: a subset of {extension, restriction}</description>
<attribute name="@param">
<description>restriction Extension or restriction constants (see
&lt;code&gt;XSConstants&lt;/code&gt;).</description>
</attribute>
<attribute name="@return">
<description>True if &lt;code&gt;restriction&lt;/code&gt; is a prohibited substitution,
otherwise false.</description>
</attribute>
</comment>
<params>
<param name="restriction" comment="Extension or restriction constants (see
&lt;code&gt;XSConstants&lt;/code&gt;)." fulltype="short" type="short" />
</params>
</method>
<method visibility="public" name="getProhibitedSubstitutions" fulltype="short" type="short">
<comment>
<description>[prohibited substitutions]: A subset of {extension, restriction} or
&lt;code&gt;DERIVATION_NONE&lt;/code&gt; represented as a bit flag (see
&lt;code&gt;XSConstants&lt;/code&gt;).</description>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api.typesystem" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType">
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<fields>
<field final="true" static="true" const="0" visibility="public" name="OCCURRENCE_OPTIONAL" constexpr="0" fulltype="short" type="short" />
<field final="true" static="true" const="1" visibility="public" name="OCCURRENCE_ONE" constexpr="1" fulltype="short" type="short" />
<field final="true" static="true" const="2" visibility="public" name="OCCURRENCE_NONE_OR_MANY" constexpr="2" fulltype="short" type="short" />
<field final="true" static="true" const="3" visibility="public" name="OCCURRENCE_ONE_OR_MANY" constexpr="3" fulltype="short" type="short" />
<field final="true" static="true" const="1" visibility="public" name="ALWAYS_ONE_MASK" constexpr="1" fulltype="short" type="short" />
<field final="true" static="true" const="2" visibility="public" name="MAYBE_MANY_MASK" constexpr="2" fulltype="short" type="short" />
</fields>
<methods>
<method visibility="public" name="getOccurrence" fulltype="short" type="short" />
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api.typesystem" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.NodeItemType" type="NodeItemType">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.ItemType" type="ItemType" />
</implements>
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="isWildcard" returncomment="Wildcard test?" fulltype="boolean" type="boolean">
<comment>
<description>For attribute and element types, return whether the name
part of the type test is a wildcard.</description>
<attribute name="@return">
<description>Wildcard test?</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getName" returncomment="name of the item type, if applicable, otherwise null" fulltype="javax.xml.namespace.QName" type="QName">
<comment>
<attribute name="@return">
<description>name of the item type, if applicable, otherwise null</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getNodeType" returncomment="The DOM node type" fulltype="short" type="short">
<comment>
<description>Node type as per list in org.w3c.dom.Node</description>
<attribute name="@return">
<description>The DOM node type</description>
</attribute>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api.typesystem" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.PrimitiveType" type="PrimitiveType">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition" />
</implements>
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="validate" returncomment="the actual value (QName, Boolean) of the string value" fulltype="boolean" type="boolean">
<comment>
<description>validate a given string against this simple type.</description>
<attribute name="@param">
<description>content the string value that needs to be validated</description>
</attribute>
<attribute name="@param">
<description>context the validation context</description>
</attribute>
<attribute name="@param">
<description>validatedInfo used to store validation result</description>
</attribute>
<attribute name="@return">
<description>the actual value (QName, Boolean) of the string value</description>
</attribute>
</comment>
<params>
<param name="content" comment="the string value that needs to be validated" fulltype="java.lang.String" type="String" />
</params>
</method>
<method visibility="public" name="validateNative" returncomment="the actual value (QName, Boolean) of the string value" fulltype="boolean" type="boolean">
<comment>
<description>validate a given string against this simple type.</description>
<attribute name="@param">
<description>content the string value that needs to be validated</description>
</attribute>
<attribute name="@param">
<description>context the validation context</description>
</attribute>
<attribute name="@param">
<description>validatedInfo used to store validation result</description>
</attribute>
<attribute name="@return">
<description>the actual value (QName, Boolean) of the string value</description>
</attribute>
</comment>
<params>
<param name="content" comment="the string value that needs to be validated" fulltype="java.lang.Object" type="Object" />
</params>
</method>
<method visibility="public" name="construct" returncomment="the actual value (QName, Boolean) of the string value" fulltype="org.eclipse.wst.xml.xpath2.api.Item" type="Item">
<comment>
<description>validate a given string against this simple type.</description>
<attribute name="@param">
<description>content the string value that needs to be validated</description>
</attribute>
<attribute name="@param">
<description>context the validation context</description>
</attribute>
<attribute name="@param">
<description>validatedInfo used to store validation result</description>
</attribute>
<attribute name="@return">
<description>the actual value (QName, Boolean) of the string value</description>
</attribute>
</comment>
<params>
<param name="content" comment="the string value that needs to be validated" fulltype="java.lang.Object" type="Object" />
</params>
</method>
<method visibility="public" name="getInterfaceClass" returncomment="the actual value (QName, Boolean) of the string value" fulltype="java.lang.Class" type="Class">
<comment>
<attribute name="@return">
<description>the actual value (QName, Boolean) of the string value</description>
</attribute>
</comment>
</method>
<method visibility="public" name="getNativeType" returncomment="The expected native type (class or interface) to expect when calling getValue." fulltype="java.lang.Class" type="Class">
<comment>
<attribute name="@return">
<description>The expected native type (class or interface) to expect when calling getValue.</description>
</attribute>
</comment>
</method>
<method visibility="public" name="isEqual" returncomment="true if the two value are equal" fulltype="boolean" type="boolean">
<comment>
<description>Check whether two actual values are equal.</description>
<attribute name="@param">
<description>value1 the first value</description>
</attribute>
<attribute name="@param">
<description>value2 the second value</description>
</attribute>
<attribute name="@return">
<description>true if the two value are equal</description>
</attribute>
</comment>
<params>
<param name="value1" comment="the first value" fulltype="java.lang.Object" type="Object" />
<param name="value2" comment="the second value" fulltype="java.lang.Object" type="Object" />
</params>
</method>
<method visibility="public" name="isIDType" returncomment="whether this simple type is or is derived from ID." fulltype="boolean" type="boolean">
<comment>
<description>Check whether this type is or is derived from ID.
REVISIT: this method makes ID special, which is not a good design.
but since ID is not a primitive, there doesn&apos;t seem to be a
clean way of doing it except to define special method like this.</description>
<attribute name="@return">
<description>whether this simple type is or is derived from ID.</description>
</attribute>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api.typesystem" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.SimpleTypeDefinition" type="SimpleTypeDefinition">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition" />
</implements>
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<fields>
<field final="true" static="true" const="0" visibility="public" name="VARIETY_ABSENT" constexpr="0" fulltype="short" type="short">
<comment>
<description>The variety is absent for the anySimpleType definition.</description>
</comment>
</field>
<field final="true" static="true" const="1" visibility="public" name="VARIETY_ATOMIC" constexpr="1" fulltype="short" type="short">
<comment>
<description>&lt;code&gt;Atomic&lt;/code&gt; type.</description>
</comment>
</field>
<field final="true" static="true" const="2" visibility="public" name="VARIETY_LIST" constexpr="2" fulltype="short" type="short">
<comment>
<description>&lt;code&gt;List&lt;/code&gt; type.</description>
</comment>
</field>
<field final="true" static="true" const="3" visibility="public" name="VARIETY_UNION" constexpr="3" fulltype="short" type="short">
<comment>
<description>&lt;code&gt;Union&lt;/code&gt; type.</description>
</comment>
</field>
</fields>
<methods>
<method visibility="public" name="getVariety" fulltype="short" type="short">
<comment>
<description>[variety]: one of {atomic, list, union} or absent.</description>
</comment>
</method>
<method visibility="public" name="getPrimitiveType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.SimpleTypeDefinition" type="SimpleTypeDefinition">
<comment>
<description>If variety is &lt;code&gt;atomic&lt;/code&gt; the primitive type definition (a
built-in primitive datatype definition or the simple ur-type
definition) is available, otherwise &lt;code&gt;null&lt;/code&gt;.</description>
</comment>
</method>
<method visibility="public" name="getBuiltInKind" fulltype="short" type="short">
<comment>
<description>Returns the closest built-in type category this type represents or
derived from. For example, if this simple type is a built-in derived
type integer the &lt;code&gt;INTEGER_DV&lt;/code&gt; is returned.
KILL!</description>
</comment>
</method>
<method visibility="public" name="getItemType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<comment>
<description>If variety is &lt;code&gt;list&lt;/code&gt; the item type definition (an atomic or
union simple type definition) is available, otherwise
&lt;code&gt;null&lt;/code&gt;.</description>
</comment>
</method>
<method visibility="public" name="getMemberTypes" fulltype="java.util.List" type="List">
<comment>
<description>If variety is &lt;code&gt;union&lt;/code&gt; the list of member type definitions (a
non-empty sequence of simple type definitions) is available,
otherwise an empty &lt;code&gt;XSObjectList&lt;/code&gt;.</description>
</comment>
</method>
<method visibility="public" name="getOrdered" fulltype="short" type="short">
<comment>
<description>Fundamental Facet: ordered.</description>
</comment>
</method>
<method visibility="public" name="getFinite" fulltype="boolean" type="boolean">
<comment>
<description>Fundamental Facet: cardinality.</description>
</comment>
</method>
<method visibility="public" name="getBounded" fulltype="boolean" type="boolean">
<comment>
<description>Fundamental Facet: bounded.</description>
</comment>
</method>
<method visibility="public" name="getNumeric" fulltype="boolean" type="boolean">
<comment>
<description>Fundamental Facet: numeric.</description>
</comment>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api.typesystem" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<comment>
<attribute name="@noimplement">
<description>This interface is not intended to be implemented by clients.</description>
</attribute>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<fields>
<field final="true" static="true" const="0" visibility="public" name="DERIVATION_NONE" constexpr="0" fulltype="short" type="short" />
<field final="true" static="true" const="1" visibility="public" name="DERIVATION_EXTENSION" constexpr="1" fulltype="short" type="short" />
<field final="true" static="true" const="2" visibility="public" name="DERIVATION_RESTRICTION" constexpr="2" fulltype="short" type="short" />
<field final="true" static="true" const="4" visibility="public" name="DERIVATION_SUBSTITUTION" constexpr="4" fulltype="short" type="short" />
<field final="true" static="true" const="8" visibility="public" name="DERIVATION_UNION" constexpr="8" fulltype="short" type="short" />
<field final="true" static="true" const="16" visibility="public" name="DERIVATION_LIST" constexpr="16" fulltype="short" type="short" />
</fields>
<methods>
<method visibility="public" name="getNamespace" fulltype="java.lang.String" type="String" />
<method visibility="public" name="getName" fulltype="java.lang.String" type="String" />
<method visibility="public" name="getBaseType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition" />
<method visibility="public" name="derivedFromType" fulltype="boolean" type="boolean">
<params>
<param name="ancestorType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition" />
<param name="derivationMethod" fulltype="short" type="short" />
</params>
</method>
<method visibility="public" name="derivedFrom" fulltype="boolean" type="boolean">
<params>
<param name="namespace" fulltype="java.lang.String" type="String" />
<param name="name" fulltype="java.lang.String" type="String" />
<param name="derivationMethod" fulltype="short" type="short" />
</params>
</method>
<method visibility="public" name="getNativeType" fulltype="java.lang.Class" type="Class" />
<method visibility="public" name="getSimpleTypes" fulltype="java.util.List" type="List">
<params>
<param name="attr" fulltype="org.w3c.dom.Attr" type="Attr" />
</params>
</method>
<method visibility="public" name="getSimpleTypes" fulltype="java.util.List" type="List">
<params>
<param name="attr" fulltype="org.w3c.dom.Element" type="Element" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.api.typesystem" interface="true" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeModel" type="TypeModel">
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="getType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<params>
<param name="node" fulltype="org.w3c.dom.Node" type="Node" />
</params>
</method>
<method visibility="public" name="lookupType" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<params>
<param name="namespace" fulltype="java.lang.String" type="String" />
<param name="typeName" fulltype="java.lang.String" type="String" />
</params>
</method>
<method visibility="public" name="lookupElementDeclaration" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<params>
<param name="namespace" fulltype="java.lang.String" type="String" />
<param name="elementName" fulltype="java.lang.String" type="String" />
</params>
</method>
<method visibility="public" name="lookupAttributeDeclaration" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition" type="TypeDefinition">
<params>
<param name="namespace" fulltype="java.lang.String" type="String" />
<param name="attributeName" fulltype="java.lang.String" type="String" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.processor" interface="true" fulltype="org.eclipse.wst.xml.xpath2.processor.CollationProvider" type="CollationProvider">
<comment>
<description>Service provider interface for looking up collations from within the dynamic context.</description>
<attribute name="@since">
<description>1.1</description>
</attribute>
<attribute name="@deprecated">
<description>Use org.eclipse.wst.xml.xpath2.api.CollationProvider instead</description>
</attribute>
</comment>
<methods>
<method visibility="public" name="get_collation" returncomment="The collation to use, or null if no such collation exists by this provider" fulltype="java.util.Comparator" type="Comparator">
<comment>
<description>Gets the named collator. W3C does not define collation names (yet?) so we are constrained to using an
implementation-defined naming scheme.</description>
<attribute name="@param">
<description>name A URI designating the collation to use</description>
</attribute>
<attribute name="@return">
<description>The collation to use, or null if no such collation exists by this provider</description>
</attribute>
</comment>
<params>
<param name="name" comment="A URI designating the collation to use" fulltype="java.lang.String" type="String" />
</params>
</method>
</methods>
</jelclass>
<jelclass superclass="Object" visibility="public" package="org.eclipse.wst.xml.xpath2.processor" superclassfulltype="java.lang.Object" fulltype="org.eclipse.wst.xml.xpath2.processor.DOMBuilder" type="DOMBuilder">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.processor.DOMLoader" type="DOMLoader" />
</implements>
<comment>
<description>The DOM builder loads an DOM from an InputStream. The loading is always namespace aware.</description>
</comment>
<fields>
<field visibility="package-private" name="_validating" fulltype="boolean" type="boolean" />
<field visibility="package-private" name="_namespace_aware" fulltype="boolean" type="boolean" />
</fields>
<methods>
<constructor visibility="public" name="DOMBuilder">
<comment>
<description>Constructor for DOM builder.</description>
</comment>
</constructor>
<method visibility="public" name="load" returncomment="The loaded document." fulltype="org.w3c.dom.Document" type="Document">
<comment>
<description>Loads The XML document.</description>
<attribute name="@param">
<description>in
is the input stream.</description>
</attribute>
<attribute name="@throws">
<description>DOMLoaderException
DOM loader exception.</description>
</attribute>
<attribute name="@return">
<description>The loaded document.</description>
</attribute>
</comment>
<params>
<param name="in" comment="is the input stream." fulltype="java.io.InputStream" type="InputStream" />
</params>
<exceptions>
<exception comment="DOM loader exception." fulltype="org.eclipse.wst.xml.xpath2.processor.DOMLoaderException" type="DOMLoaderException" />
</exceptions>
</method>
<method visibility="public" name="set_validating" fulltype="void" type="void">
<comment>
<description>Set validating boolean.</description>
<attribute name="@param">
<description>x
is the value to set the validating boolean to.</description>
</attribute>
</comment>
<params>
<param name="x" comment="is the value to set the validating boolean to." fulltype="boolean" type="boolean" />
</params>
</method>
</methods>
</jelclass>
<jelclass abstract="true" visibility="public" package="org.eclipse.wst.xml.xpath2.processor" interface="true" fulltype="org.eclipse.wst.xml.xpath2.processor.DOMLoader" type="DOMLoader">
<comment>
<description>The DOM loader loads the XML document.</description>
</comment>
<methods>
<method visibility="public" name="load" returncomment="The loaded document. The document is always loaded as namespace-aware" fulltype="org.w3c.dom.Document" type="Document">
<comment>
<description>The DOM loader loads the XML docuemnt</description>
<attribute name="@param">
<description>in
is the input stream.</description>
</attribute>
<attribute name="@throws">
<description>DOMLoaderException
DOM loader exception.</description>
</attribute>
<attribute name="@return">
<description>The loaded document. The document is always loaded as namespace-aware</description>
</attribute>
</comment>
<params>
<param name="in" comment="is the input stream." fulltype="java.io.InputStream" type="InputStream" />
</params>
<exceptions>
<exception comment="DOM loader exception." fulltype="org.eclipse.wst.xml.xpath2.processor.DOMLoaderException" type="DOMLoaderException" />
</exceptions>
</method>
<method visibility="public" name="set_validating" fulltype="void" type="void">
<comment>
<description>Set validating boolean.</description>
<attribute name="@param">
<description>val
is the validating boolean.</description>
</attribute>
</comment>
<params>
<param name="val" comment="is the validating boolean." fulltype="boolean" type="boolean" />
</params>
</method>
</methods>
</jelclass>
<jelclass superclass="XPathException" visibility="public" package="org.eclipse.wst.xml.xpath2.processor" serializable="true" superclassfulltype="org.eclipse.wst.xml.xpath2.processor.XPathException" fulltype="org.eclipse.wst.xml.xpath2.processor.DOMLoaderException" type="DOMLoaderException">
<comment>
<description>Exception caused by DOM loader.</description>
<attribute name="@deprecated">
<description>Only used in deprecated APIs</description>
</attribute>
</comment>
<methods>
<constructor visibility="public" name="DOMLoaderException">
<comment>
<description>Constructor for DOM loader exception.</description>
<attribute name="@param">
<description>reason
is the reason for the exception.</description>
</attribute>
</comment>
<params>
<param name="reason" comment="is the reason for the exception." fulltype="java.lang.String" type="String" />
</params>
</constructor>
</methods>
</jelclass>
<jelclass superclass="DefaultStaticContext" visibility="public" package="org.eclipse.wst.xml.xpath2.processor" superclassfulltype="org.eclipse.wst.xml.xpath2.processor.internal.DefaultStaticContext" fulltype="org.eclipse.wst.xml.xpath2.processor.DefaultDynamicContext" type="DefaultDynamicContext">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.processor.DynamicContext" type="DynamicContext" />
</implements>
<comment>
<description>The default implementation of a Dynamic Context.
Initializes and provides functionality of a dynamic context according to the
XPath 2.0 specification.</description>
</comment>
<methods>
<constructor visibility="public" name="DefaultDynamicContext">
<comment>
<description>Constructor.</description>
<attribute name="@param">
<description>schema
Schema information of document. May be null</description>
</attribute>
<attribute name="@param">
<description>doc
Document [root] node of XML source.</description>
</attribute>
</comment>
<params>
<param name="schema" comment="Schema information of document. May be null" fulltype="XSModel" type="XSModel" />
<param name="doc" comment="Document [root] node of XML source." fulltype="org.w3c.dom.Document" type="Document" />
</params>
</constructor>
<constructor visibility="public" name="DefaultDynamicContext">
<comment>
<description>Constructor.</description>
<attribute name="@param">
<description>schema
Schema information of document. May be null</description>
</attribute>
<attribute name="@param">
<description>doc
Document [root] node of XML source.</description>
</attribute>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<params>
<param name="schema" comment="Schema information of document. May be null" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeModel" type="TypeModel" />
</params>
</constructor>
<method visibility="public" name="tz" returncomment="an xs:integer _tz" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration" type="XSDuration">
<comment>
<description>Reads the day from a TimeDuration type</description>
<attribute name="@return">
<description>an xs:integer _tz</description>
</attribute>
<attribute name="@since">
<description>1.1</description>
</attribute>
</comment>
</method>
<method visibility="public" name="current_date_time" fulltype="java.util.GregorianCalendar" type="GregorianCalendar">
<comment>
<description>Gets the Current stable date time from the dynamic context.</description>
<attribute name="@since">
<description>1.1</description>
</attribute>
<attribute name="@see">
<description>org.eclipse.wst.xml.xpath2.processor.DynamicContext#get_current_time()</description>
</attribute>
</comment>
</method>
<method visibility="public" name="set_focus" fulltype="void" type="void">
<comment>
<description>Changes the current focus.</description>
<attribute name="@param">
<description>f
focus to set</description>
</attribute>
</comment>
<params>
<param name="f" comment="focus to set" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.Focus" type="Focus" />
</params>
</method>
<method visibility="public" name="focus" returncomment="_focus" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.Focus" type="Focus">
<comment>
<description>Return the focus</description>
<attribute name="@return">
<description>_focus</description>
</attribute>
</comment>
</method>
<method visibility="public" name="context_item" returncomment="an AnyType result from _focus.context_item()" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType" type="AnyType">
<comment>
<description>Retrieve context item that is in focus</description>
<attribute name="@return">
<description>an AnyType result from _focus.context_item()</description>
</attribute>
</comment>
</method>
<method visibility="public" name="context_position" returncomment="an integer result from _focus.position()" fulltype="int" type="int">
<comment>
<description>Retrieve the position of the focus</description>
<attribute name="@return">
<description>an integer result from _focus.position()</description>
</attribute>
</comment>
</method>
<method visibility="public" name="last" returncomment="an integer result from _focus.last()" fulltype="int" type="int">
<comment>
<description>Retrieve the position of the last focus</description>
<attribute name="@return">
<description>an integer result from _focus.last()</description>
</attribute>
</comment>
</method>
<method visibility="public" name="get_variable" returncomment="an AnyType result from get_var(name) or return NULL" fulltype="java.lang.Object" type="Object">
<comment>
<description>Retrieve the variable name</description>
<attribute name="@return">
<description>an AnyType result from get_var(name) or return NULL</description>
</attribute>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<params>
<param name="name" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.types.QName" type="QName" />
</params>
</method>
<method visibility="public" name="evaluate_function" returncomment="a ResultSequence from funct.evaluate(args)" fulltype="org.eclipse.wst.xml.xpath2.processor.ResultSequence" type="ResultSequence">
<comment>
<attribute name="@return">
<description>a ResultSequence from funct.evaluate(args)</description>
</attribute>
</comment>
<params>
<param name="name" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.types.QName" type="QName" />
<param name="args" fulltype="java.util.Collection" type="Collection" />
</params>
<exceptions>
<exception fulltype="org.eclipse.wst.xml.xpath2.processor.DynamicError" type="DynamicError" />
</exceptions>
</method>
<method visibility="public" name="add_function_library" fulltype="void" type="void">
<comment>
<description>Adds function definitions.</description>
<attribute name="@param">
<description>fl
Function library to add.</description>
</attribute>
</comment>
<params>
<param name="fl" comment="Function library to add." fulltype="FunctionLibrary" type="FunctionLibrary" />
</params>
</method>
<method visibility="public" name="get_doc" returncomment="a ResultSequence from ResultSequenceFactory.create_new()" fulltype="org.eclipse.wst.xml.xpath2.processor.ResultSequence" type="ResultSequence">
<comment>
<description>get document</description>
<attribute name="@return">
<description>a ResultSequence from ResultSequenceFactory.create_new()</description>
</attribute>
<attribute name="@since">
<description>1.1</description>
</attribute>
</comment>
<params>
<param name="resolved" fulltype="java.net.URI" type="URI" />
</params>
</method>
<method visibility="public" name="resolve_uri" fulltype="java.net.URI" type="URI">
<comment>
<attribute name="@since">
<description>1.1</description>
</attribute>
</comment>
<params>
<param name="uri" fulltype="java.lang.String" type="String" />
</params>
</method>
<method visibility="public" name="set_variable" fulltype="void" type="void">
<comment>
<description>Sets the value of a variable.</description>
<attribute name="@param">
<description>var
Variable name.</description>
</attribute>
<attribute name="@param">
<description>val
Variable value.</description>
</attribute>
</comment>
<params>
<param name="var" comment="Variable name." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.types.QName" type="QName" />
<param name="val" comment="Variable value." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType" type="AnyType" />
</params>
</method>
<method visibility="public" name="set_variable" fulltype="void" type="void">
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<params>
<param name="var" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.types.QName" type="QName" />
<param name="val" fulltype="org.eclipse.wst.xml.xpath2.processor.ResultSequence" type="ResultSequence" />
</params>
</method>
<method visibility="public" name="set_default_collation" fulltype="void" type="void">
<comment>
<attribute name="@since">
<description>1.1</description>
</attribute>
</comment>
<params>
<param name="_default_collation" fulltype="java.lang.String" type="String" />
</params>
</method>
<method visibility="public" name="default_collation_name" fulltype="java.lang.String" type="String">
<comment>
<attribute name="@since">
<description>1.1</description>
</attribute>
</comment>
</method>
<method visibility="public" name="get_collation" fulltype="java.util.Comparator" type="Comparator">
<comment>
<attribute name="@since">
<description>1.1</description>
</attribute>
</comment>
<params>
<param name="uri" fulltype="java.lang.String" type="String" />
</params>
</method>
<method visibility="public" name="set_collation_provider" fulltype="void" type="void">
<comment>
<attribute name="@param">
<description>provider</description>
</attribute>
<attribute name="@since">
<description>1.1</description>
</attribute>
</comment>
<params>
<param name="provider" comment="" fulltype="org.eclipse.wst.xml.xpath2.processor.CollationProvider" type="CollationProvider" />
</params>
</method>
<method visibility="public" name="node_position" fulltype="int" type="int">
<comment>
<description>Use focus().position() to retrieve the value.</description>
<attribute name="@deprecated">
<description>This will be removed in a future version use focus().position().</description>
</attribute>
</comment>
<params>
<param name="node" fulltype="org.w3c.dom.Node" type="Node" />
</params>
</method>
<method visibility="public" name="getTypeModel" fulltype="org.eclipse.wst.xml.xpath2.api.typesystem.TypeModel" type="TypeModel">
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<params>
<param name="node" fulltype="org.w3c.dom.Node" type="Node" />
</params>
</method>
</methods>
</jelclass>
<jelclass superclass="Object" visibility="public" package="org.eclipse.wst.xml.xpath2.processor" superclassfulltype="java.lang.Object" fulltype="org.eclipse.wst.xml.xpath2.processor.DefaultEvaluator" type="DefaultEvaluator">
<implements>
<interface fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.XPathVisitor" type="XPathVisitor" />
<interface fulltype="org.eclipse.wst.xml.xpath2.processor.Evaluator" type="Evaluator" />
</implements>
<comment>
<description>Default evaluator interface</description>
</comment>
<methods>
<constructor visibility="public" name="DefaultEvaluator">
<params>
<param name="dynamicContext" fulltype="org.eclipse.wst.xml.xpath2.processor.DynamicContext" type="DynamicContext" />
<param name="doc" fulltype="org.w3c.dom.Document" type="Document" />
</params>
</constructor>
<constructor visibility="public" name="DefaultEvaluator">
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<params>
<param name="staticContext" fulltype="org.eclipse.wst.xml.xpath2.api.StaticContext" type="StaticContext" />
<param name="dynamicContext" fulltype="org.eclipse.wst.xml.xpath2.api.DynamicContext" type="DynamicContext" />
<param name="contextItems" fulltype="java.lang.Object[]" type="Object" />
</params>
</constructor>
<method visibility="package-private" name="focus" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.Focus" type="Focus" />
<method visibility="package-private" name="set_focus" fulltype="void" type="void">
<params>
<param name="f" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.Focus" type="Focus" />
</params>
</method>
<method visibility="public" name="evaluate" returncomment="result sequence." fulltype="org.eclipse.wst.xml.xpath2.processor.ResultSequence" type="ResultSequence">
<comment>
<description>evaluate the xpath node</description>
<attribute name="@param">
<description>node
is the xpath node.</description>
</attribute>
<attribute name="@throws">
<description>dynamic
error.</description>
</attribute>
<attribute name="@return">
<description>result sequence.</description>
</attribute>
</comment>
<params>
<param name="node" comment="is the xpath node." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.XPathNode" type="XPathNode" />
</params>
</method>
<method visibility="public" name="evaluate2" fulltype="org.eclipse.wst.xml.xpath2.api.ResultSequence" type="ResultSequence">
<comment>
<attribute name="@since">
<description>2.0</description>
</attribute>
</comment>
<params>
<param name="node" fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.XPathNode" type="XPathNode" />
</params>
</method>
<method visibility="public" name="visit" returncomment="result sequence." fulltype="java.lang.Object" type="Object">
<comment>
<description>iterate through xpath expression</description>
<attribute name="@param">
<description>xp
is the xpath.</description>
</attribute>
<attribute name="@return">
<description>result sequence.</description>
</attribute>
</comment>
<params>
<param name="xp" comment="is the xpath." fulltype="org.eclipse.wst.xml.xpath2.processor.ast.XPath" type="XPath" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function." fulltype="java.lang.Object" type="Object">
<comment>
<description>visit for expression</description>
<attribute name="@param">
<description>fex
is the for expression.</description>
</attribute>
<attribute name="@return">
<description>a new function.</description>
</attribute>
</comment>
<params>
<param name="fex" comment="is the for expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.ForExpr" type="ForExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function or null." fulltype="java.lang.Object" type="Object">
<comment>
<description>visit quantified expression</description>
<attribute name="@param">
<description>qex
is the quantified expression.</description>
</attribute>
<attribute name="@return">
<description>a new function or null.</description>
</attribute>
</comment>
<params>
<param name="qex" comment="is the quantified expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.QuantifiedExpr" type="QuantifiedExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a ifex.then_clause().accept(this)." fulltype="java.lang.Object" type="Object">
<comment>
<description>visit if expression</description>
<attribute name="@param">
<description>ifex
is the if expression.</description>
</attribute>
<attribute name="@return">
<description>a ifex.then_clause().accept(this).</description>
</attribute>
</comment>
<params>
<param name="ifex" comment="is the if expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.IfExpr" type="IfExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit or expression</description>
<attribute name="@param">
<description>orex
is the or expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="orex" comment="is the or expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.OrExpr" type="OrExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit and expression</description>
<attribute name="@param">
<description>andex
is the and expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="andex" comment="is the and expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.AndExpr" type="AndExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function or null" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit compare expression</description>
<attribute name="@param">
<description>cmpex
is the compare expression.</description>
</attribute>
<attribute name="@return">
<description>a new function or null</description>
</attribute>
</comment>
<params>
<param name="cmpex" comment="is the compare expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.CmpExpr" type="CmpExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit range expression</description>
<attribute name="@param">
<description>rex
is the range expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="rex" comment="is the range expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.RangeExpr" type="RangeExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit and expression</description>
<attribute name="@param">
<description>addex
is the and expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="addex" comment="is the and expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.AddExpr" type="AddExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit sub expression</description>
<attribute name="@param">
<description>subex
is the sub expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="subex" comment="is the sub expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.SubExpr" type="SubExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit multiply expression</description>
<attribute name="@param">
<description>mulex
is the mul expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="mulex" comment="is the mul expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.MulExpr" type="MulExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit division expression</description>
<attribute name="@param">
<description>mulex
is the division expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="mulex" comment="is the division expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.DivExpr" type="DivExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit integer division expression</description>
<attribute name="@param">
<description>mulex
is the integer division expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="mulex" comment="is the integer division expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.IDivExpr" type="IDivExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit modular expression</description>
<attribute name="@param">
<description>mulex
is the modular expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="mulex" comment="is the modular expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.ModExpr" type="ModExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit union expression</description>
<attribute name="@param">
<description>unex
is the union expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="unex" comment="is the union expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.UnionExpr" type="UnionExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit pipe expression</description>
<attribute name="@param">
<description>pipex
is the pipe expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="pipex" comment="is the pipe expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.PipeExpr" type="PipeExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit intersect expression</description>
<attribute name="@param">
<description>iexpr
is the intersect expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="iexpr" comment="is the intersect expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.IntersectExpr" type="IntersectExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit except expression</description>
<attribute name="@param">
<description>eexpr
is the except expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="eexpr" comment="is the except expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.ExceptExpr" type="ExceptExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit instance of expression</description>
<attribute name="@param">
<description>ioexp
is the instance of expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="ioexp" comment="is the instance of expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.InstOfExpr" type="InstOfExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit treat-as expression</description>
<attribute name="@param">
<description>taexp
is the treat-as expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>
<params>
<param name="taexp" comment="is the treat-as expression." fulltype="org.eclipse.wst.xml.xpath2.processor.internal.ast.TreatAsExpr" type="TreatAsExpr" />
</params>
</method>
<method visibility="public" name="visit" returncomment="a new function" fulltype="java.lang.Object" type="Object">
<comment>
<description>visit castable expression</description>
<attribute name="@param">
<description>cexp
is the castable expression.</description>
</attribute>
<attribute name="@return">
<description>a new function</description>
</attribute>
</comment>