|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines an XQuery library module. A module consists of function definitions
and global variables. It is uniquely identified by a namespace URI and an optional
default namespace prefix. All functions provided by the module have to be defined
in the module's namespace.
Modules can be either internal or external: internal modules are collections of Java
classes, each being a subclass of Function
. External modules
are defined by the XQuery "module" directive and can be loaded with "import module".
Modules are dynamically loaded by class XQueryContext
, either
during the initialization phase of the query engine (for the standard library modules) or
upon an "import module" directive.
Field Summary | |
static java.lang.String |
REQUEST_FUNCTION_NS
Namespace for the built-in request module. |
static java.lang.String |
RESPONSE_FUNCTION_NS
Namespace for the built-in response module. |
static java.lang.String |
SESSION_FUNCTION_NS
Namespace for the built-in session module. |
static java.lang.String |
SYSTEM_FUNCTION_NS
Namespace for the built-in system module. |
static java.lang.String |
TEXT_FUNCTION_NS
Namespace for the built-in text module. |
static java.lang.String |
TRANSFORM_FUNCTION_NS
Namespace for the built-in transform module. |
static java.lang.String |
UTIL_FUNCTION_NS
Namespace for the built-in utility module. |
static java.lang.String |
XMLDB_FUNCTION_NS
Namespace for the built-in xmldb module. |
Method Summary | |
Variable |
declareVariable(QName qname,
java.lang.Object value)
|
Variable |
declareVariable(Variable var)
|
java.lang.String |
getDefaultPrefix()
Returns an optional default prefix (used if no prefix is supplied with the "import module" directive). |
java.lang.String |
getDescription()
Return a short description of this module to be displayed to a user. |
java.lang.String |
getNamespaceURI()
Returns the namespace URI that uniquely identifies this module. |
java.util.Iterator |
getSignaturesForFunction(QName qname)
Try to find the signature of the function identified by its QName. |
boolean |
isInternalModule()
Is this an internal module? |
boolean |
isVarDeclared(QName qname)
|
FunctionSignature[] |
listFunctions()
Returns the signatures of all functions defined within this module. |
void |
reset()
Reset the module's internal state for being reused. |
Variable |
resolveVariable(QName qname)
|
Field Detail |
public static final java.lang.String XMLDB_FUNCTION_NS
public static final java.lang.String UTIL_FUNCTION_NS
public static final java.lang.String REQUEST_FUNCTION_NS
public static final java.lang.String RESPONSE_FUNCTION_NS
public static final java.lang.String SESSION_FUNCTION_NS
public static final java.lang.String SYSTEM_FUNCTION_NS
public static final java.lang.String TRANSFORM_FUNCTION_NS
public static final java.lang.String TEXT_FUNCTION_NS
Method Detail |
public java.lang.String getNamespaceURI()
public java.lang.String getDefaultPrefix()
public java.lang.String getDescription()
public boolean isInternalModule()
public FunctionSignature[] listFunctions()
public java.util.Iterator getSignaturesForFunction(QName qname)
qname
-
public Variable resolveVariable(QName qname) throws XPathException
XPathException
public Variable declareVariable(QName qname, java.lang.Object value) throws XPathException
XPathException
public Variable declareVariable(Variable var)
public boolean isVarDeclared(QName qname)
public void reset()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |