org.exist.backup.xquery
Class BackupModule

java.lang.Object
  org.exist.xquery.AbstractInternalModule
      org.exist.backup.xquery.BackupModule

All Implemented Interfaces:

InternalModule, Module

public class BackupModule
extends AbstractInternalModule

Module function definitions for backup module.

Author:

wolf, ljo

Nested Class Summary

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

AbstractInternalModule.FunctionComparator

Field Summary

static FunctionDef[]	functions
static String	INCLUSION_DATE
static String	NAMESPACE_URI
static String	PREFIX
static String	RELEASED_IN_VERSION

Constructor Summary

BackupModule()

Method Summary

String	getDefaultPrefix() Returns an optional default prefix (used if no prefix is supplied with the "import module" directive).
String	getDescription() Module description for the documentation.
String	getNamespaceURI() Returns the namespace URI that uniquely identifies this module.
String	getReleaseVersion() Module release version for the documentation.

Methods inherited from class org.exist.xquery.AbstractInternalModule

declareVariable, declareVariable, getFunctionDef, getFunctionsByName, getSignaturesForFunction, isInternalModule, isVarDeclared, listFunctions, reset, resolveVariable

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_URI

public static final String NAMESPACE_URI

See Also:

Constant Field Values

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

INCLUSION_DATE

public static final String INCLUSION_DATE

See Also:

Constant Field Values

RELEASED_IN_VERSION

public static final String RELEASED_IN_VERSION

See Also:

Constant Field Values

functions

public static final FunctionDef[] functions

Constructor Detail

BackupModule

public BackupModule()

Method Detail

getNamespaceURI

public String getNamespaceURI()

Description copied from interface: Module

Returns the namespace URI that uniquely identifies this module.

Specified by:

getNamespaceURI in interface Module

Specified by:

getNamespaceURI in class AbstractInternalModule

Returns:

namespace URI

getDefaultPrefix

public String getDefaultPrefix()

Description copied from interface: Module

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

Specified by:

getDefaultPrefix in interface Module

Specified by:

getDefaultPrefix in class AbstractInternalModule

Returns:

optional default prefix

getDescription

public String getDescription()

Description copied from class: AbstractInternalModule

Module description for the documentation. This is a short phrase describing the module, starting with: A module for.

Specified by:

getDescription in interface Module

Specified by:

getDescription in class AbstractInternalModule

Returns:

short description of this module

getReleaseVersion

public String getReleaseVersion()

Description copied from class: AbstractInternalModule

Module release version for the documentation. Since a module can live in trunk a long time before it is included in a release, this is neccessary for the documentation.

Specified by:

getReleaseVersion in interface Module

Specified by:

getReleaseVersion in class AbstractInternalModule

Returns:

available from which release version