|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.xquery.AbstractInternalModule
public abstract class AbstractInternalModule
Abstract base class for an InternalModule
.
Functions are defined in an array of FunctionDef
, which
is passed to the constructor. A single implementation class
can be registered for more than one function signature, given that the signatures differ
in name or the number of expected arguments. It is thus possible to implement
similar XQuery functions in one single class.
Nested Class Summary | |
---|---|
static class |
AbstractInternalModule.FunctionComparator
|
Constructor Summary | |
---|---|
AbstractInternalModule(FunctionDef[] functions)
|
|
AbstractInternalModule(FunctionDef[] functions,
boolean functionsOrdered)
|
Method Summary | |
---|---|
Variable |
declareVariable(QName qname,
Object value)
|
Variable |
declareVariable(Variable var)
|
abstract String |
getDefaultPrefix()
Returns an optional default prefix (used if no prefix is supplied with the "import module" directive). |
FunctionDef |
getFunctionDef(QName qname,
int arity)
Returns the implementing class for the function identified by qname or null if it is not defined. |
List |
getFunctionsByName(QName qname)
Returns all functions defined in this module matching the specified qname. |
abstract String |
getNamespaceURI()
Returns the namespace URI that uniquely identifies this module. |
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(XQueryContext xqueryContext)
Reset the module's internal state for being reused. |
Variable |
resolveVariable(QName qname)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.exist.xquery.Module |
---|
getDescription |
Constructor Detail |
---|
public AbstractInternalModule(FunctionDef[] functions)
public AbstractInternalModule(FunctionDef[] functions, boolean functionsOrdered)
Method Detail |
---|
public boolean isInternalModule()
Module
isInternalModule
in interface Module
public abstract String getNamespaceURI()
Module
getNamespaceURI
in interface Module
public abstract String getDefaultPrefix()
Module
getDefaultPrefix
in interface Module
public FunctionSignature[] listFunctions()
Module
listFunctions
in interface Module
public Iterator getSignaturesForFunction(QName qname)
Module
getSignaturesForFunction
in interface Module
public FunctionDef getFunctionDef(QName qname, int arity)
InternalModule
FunctionFactory
.
getFunctionDef
in interface InternalModule
public List getFunctionsByName(QName qname)
InternalModule
getFunctionsByName
in interface InternalModule
public Variable declareVariable(QName qname, Object value) throws XPathException
declareVariable
in interface Module
XPathException
public Variable declareVariable(Variable var)
declareVariable
in interface Module
public Variable resolveVariable(QName qname) throws XPathException
resolveVariable
in interface Module
XPathException
public boolean isVarDeclared(QName qname)
isVarDeclared
in interface Module
public void reset(XQueryContext xqueryContext)
Module
reset
in interface Module
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |