|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.xquery.ExternalModuleImpl
Default implementation of an ExternalModule
.
Field Summary |
Fields inherited from interface org.exist.xquery.Module |
REQUEST_FUNCTION_NS, RESPONSE_FUNCTION_NS, SESSION_FUNCTION_NS, SYSTEM_FUNCTION_NS, TEXT_FUNCTION_NS, TRANSFORM_FUNCTION_NS, UTIL_FUNCTION_NS, XMLDB_FUNCTION_NS |
Constructor Summary | |
ExternalModuleImpl(java.lang.String namespaceURI,
java.lang.String prefix)
|
Method Summary | |
void |
declareFunction(UserDefinedFunction func)
Declare a new function. |
Variable |
declareVariable(QName qname,
java.lang.Object value)
|
void |
declareVariable(QName qname,
VariableDeclaration decl)
|
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. |
UserDefinedFunction |
getFunction(QName qname,
int arity)
Try to find the function identified by qname. |
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. |
Source |
getSource()
Get the source object this module has been read from. |
boolean |
isInternalModule()
Is this an internal module? |
boolean |
isVarDeclared(QName qname)
|
FunctionSignature[] |
listFunctions()
Returns the signatures of all functions defined within this module. |
boolean |
moduleIsValid()
Is this module still valid or should it be reloaded from its source? |
void |
reset()
Reset the module's internal state for being reused. |
Variable |
resolveVariable(QName qname)
|
void |
setContext(XQueryContext context)
Set the XQueryContext of this module. |
void |
setSource(Source source)
Set the source object this module has been read from. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ExternalModuleImpl(java.lang.String namespaceURI, java.lang.String prefix)
Method Detail |
public java.lang.String getDescription()
Module
getDescription
in interface Module
public UserDefinedFunction getFunction(QName qname, int arity)
ExternalModule
getFunction
in interface ExternalModule
qname
- public void declareFunction(UserDefinedFunction func)
ExternalModule
declareFunction
in interface ExternalModule
func
- public java.lang.String getNamespaceURI()
Module
getNamespaceURI
in interface Module
public java.lang.String getDefaultPrefix()
Module
getDefaultPrefix
in interface Module
public boolean isInternalModule()
Module
isInternalModule
in interface Module
public FunctionSignature[] listFunctions()
Module
listFunctions
in interface Module
public java.util.Iterator getSignaturesForFunction(QName qname)
Module
getSignaturesForFunction
in interface Module
qname
-
public Variable declareVariable(QName qname, java.lang.Object value) throws XPathException
declareVariable
in interface Module
XPathException
public Variable declareVariable(Variable var)
declareVariable
in interface Module
public void declareVariable(QName qname, VariableDeclaration decl) throws XPathException
declareVariable
in interface ExternalModule
XPathException
public boolean isVarDeclared(QName qname)
isVarDeclared
in interface Module
public Variable resolveVariable(QName qname) throws XPathException
resolveVariable
in interface Module
XPathException
public Source getSource()
ExternalModule
getSource
in interface ExternalModule
public void setSource(Source source)
ExternalModule
setSource
in interface ExternalModule
source
- public void setContext(XQueryContext context)
ExternalModule
setContext
in interface ExternalModule
context
- public boolean moduleIsValid()
ExternalModule
moduleIsValid
in interface ExternalModule
public void reset()
Module
reset
in interface Module
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |