org.exist.xquery.functions.util
Class UtilModule

java.lang.Object
  org.exist.xquery.AbstractInternalModule
      org.exist.xquery.functions.util.UtilModule

All Implemented Interfaces:

InternalModule, Module

public class UtilModule
extends AbstractInternalModule

Module function definitions for util module.

Nested Class Summary

Nested classes/interfaces inherited from class org.exist.xquery.AbstractInternalModule

AbstractInternalModule.FunctionComparator

Field Summary

static QName	EXCEPTION_MESSAGE_QNAME
static QName	EXCEPTION_QNAME
static FunctionDef[]	functions
static java.lang.String	INCLUSION_DATE
static java.lang.String	NAMESPACE_URI
static java.lang.String	PREFIX
static java.lang.String	RELEASED_IN_VERSION

Fields inherited from class org.exist.xquery.AbstractInternalModule

mFunctions, mGlobalVariables, ordered

Constructor Summary

UtilModule(java.util.Map<java.lang.String,java.util.List<? extends java.lang.Object>> parameters)

Method Summary

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.lang.String	getReleaseVersion() Returns the release version in which the module was firstly available.

Methods inherited from class org.exist.xquery.AbstractInternalModule

declareVariable, declareVariable, getFunctionDef, getFunctionsByName, getGlobalVariables, getParameter, getSignaturesForFunction, isInternalModule, isReady, isVarDeclared, listFunctions, reset, resolveVariable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAMESPACE_URI

public static final java.lang.String NAMESPACE_URI

See Also:

Constant Field Values

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

INCLUSION_DATE

public static final java.lang.String INCLUSION_DATE

See Also:

Constant Field Values

RELEASED_IN_VERSION

public static final java.lang.String RELEASED_IN_VERSION

See Also:

Constant Field Values

functions

public static final FunctionDef[] functions

EXCEPTION_QNAME

public static final QName EXCEPTION_QNAME

EXCEPTION_MESSAGE_QNAME

public static final QName EXCEPTION_MESSAGE_QNAME

Constructor Detail

UtilModule

public UtilModule(java.util.Map<java.lang.String,java.util.List<? extends java.lang.Object>> parameters)
           throws XPathException

Throws:

XPathException

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: Module

Return a short description of this module to be displayed to a user.

Returns:

short description of this module

getNamespaceURI

public java.lang.String getNamespaceURI()

Description copied from interface: Module

Returns the namespace URI that uniquely identifies this module.

Returns:

namespace URI

getDefaultPrefix

public java.lang.String getDefaultPrefix()

Description copied from interface: Module

Returns an optional default prefix (used if no prefix is supplied with the "import module" directive).

Returns:

optional default prefix

getReleaseVersion

public java.lang.String getReleaseVersion()

Description copied from interface: Module

Returns the release version in which the module was firstly available.

Returns:

available from which release version