|
API | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
public interface XExecutable
Base executable class. Provides common execute methods.
Parameters to the execute methods include:
Source object or an XItemView object for
the initial context item. Valid Source types are:
StreamSourceSAXSourceDOMSourceStAXSourceXDynamicContext object containing the execution-time settings. If none
is provided the default settings are used.The return value is an XSequenceCursor which is
a cursor view of the resulting sequence of items. A List of
XItemView return type is also provided for random access.
If the result is the empty sequence and the return type is XSequenceCursor
then the value will be null. If the result is empty and the
return type is List then the value will be an empty list.
Note that XSequenceCursor implements XItemView allowing
the result of one execution to be passed in as the context item for another.
All XExecutable objects are thread safe.
XDynamicContext,
XSequenceCursor,
XItemView,
XPathExecutable,
XQueryExecutable,
XSLTExecutable| Method Summary | |
|---|---|
XSequenceCursor |
execute()
Execute for no source. |
XSequenceCursor |
execute(Source source)
Execute for the given source. |
XSequenceCursor |
execute(Source source,
XDynamicContext dynamicContext)
Execute for the given source and dynamic context. |
XSequenceCursor |
execute(XDynamicContext dynamicContext)
Execute for no source. |
XSequenceCursor |
execute(XItemView item)
Execute for the given item. |
XSequenceCursor |
execute(XItemView item,
XDynamicContext dynamicContext)
Execute for the given item and dynamic context. |
List<XItemView> |
executeToList()
Execute for no source. |
List<XItemView> |
executeToList(Source source)
Execute for the given source. |
List<XItemView> |
executeToList(Source source,
XDynamicContext dynamicContext)
Execute for the given source and dynamic context. |
List<XItemView> |
executeToList(XDynamicContext dynamicContext)
Execute for no source. |
List<XItemView> |
executeToList(XItemView item)
Execute for the given item. |
List<XItemView> |
executeToList(XItemView item,
XDynamicContext dynamicContext)
Execute for the given item and dynamic context. |
| Method Detail |
|---|
XSequenceCursor execute(Source source)
source - The input source. May be null for XPath and XQuery.
Note that if the context item is null and an expression accesses the context item
an error will be raised by the processor (it is an error if a part of the
dynamic context is accessed which has not been initialized).
null if the result is
empty.
XSequenceCursor execute(Source source,
XDynamicContext dynamicContext)
source - The input source. May be null for XPath and XQuery and for XSLT
when an initial named template is specified using XDynamicContext.setXSLTInitialTemplate(QName).
Note that if the context item is null and an expression accesses the context item
an error will be raised by the processor (it is an error if a part of the
dynamic context is accessed which has not been initialized).dynamicContext - The dynamic context.
null if the result is
empty.XSequenceCursor execute(XItemView item)
item - The context item. May be null for XPath and XQuery.
Note that if the context item is null and an expression accesses the context item
an error will be raised by the processor (it is an error if a part of the
dynamic context is accessed which has not been initialized).
null if the result is
empty.
XSequenceCursor execute(XItemView item,
XDynamicContext dynamicContext)
item - The context item. May be null for XPath and XQuery and for XSLT
when an initial named template is specified using XDynamicContext.setXSLTInitialTemplate(QName).
Note that if the context item is null and an expression accesses the context item
an error will be raised by the processor (it is an error if a part of the
dynamic context is accessed which has not been initialized).dynamicContext - The dynamic context.
null if the result is
empty.XSequenceCursor execute()
null if the result is empty.XSequenceCursor execute(XDynamicContext dynamicContext)
XDynamicContext.setXSLTInitialTemplate(QName).
dynamicContext - The dynamic context.
null if the result is empty.List<XItemView> executeToList(Source source)
source - The input source. May be null for XPath and XQuery.
Note that if the context item is null and an expression accesses the context item
an error will be raised by the processor (it is an error if a part of the
dynamic context is accessed which has not been initialized).
XItemView. If the result of the
execution is empty then an empty list is returned.
List<XItemView> executeToList(Source source,
XDynamicContext dynamicContext)
source - The input source. May be null for XPath and XQuery and for XSLT
when an initial named template is specified using XDynamicContext.setXSLTInitialTemplate(QName).
Note that if the context item is null and an expression accesses the context item
an error will be raised by the processor (it is an error if a part of the
dynamic context is accessed which has not been initialized).
XItemView. If the result of the
execution is empty then an empty list is returned.List<XItemView> executeToList(XItemView item)
item - The context item. May be null for XPath and XQuery.
Note that if the context item is null and an expression accesses the context item
an error will be raised by the processor (it is an error if a part of the
dynamic context is accessed which has not been initialized).
XItemView. If the result of the
execution is empty then an empty list is returned.
List<XItemView> executeToList(XItemView item,
XDynamicContext dynamicContext)
item - The context item. May be null for XPath and XQuery and for XSLT
when an initial named template is specified using XDynamicContext.setXSLTInitialTemplate(QName).
Note that if the context item is null and an expression accesses the context item
an error will be raised by the processor (it is an error if a part of the
dynamic context is accessed which has not been initialized).dynamicContext - The dynamic context.
XItemView. If the result of the
execution is empty then an empty list is returned.List<XItemView> executeToList()
XItemView. If the result of the
execution is empty then an empty list is returned.List<XItemView> executeToList(XDynamicContext dynamicContext)
XDynamicContext.setXSLTInitialTemplate(QName).
dynamicContext - The dynamic context.
XItemView. If the result of the
execution is empty then an empty list is returned.
|
IBM Copyright 2004-2008 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||