eu.dnetlib.xml.database.exist

Class ExistDatabase

java.lang.Object

eu.dnetlib.xml.database.exist.ExistDatabase

All Implemented Interfaces:

XMLDatabase, org.springframework.context.Lifecycle

Direct Known Subclasses:

PersistentExistDatabase, TemporaryExistDatabase

public class ExistDatabase
extends Object
implements XMLDatabase, org.springframework.context.Lifecycle

eXist database wrapper.

Author:

marko

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_XCONF eXist collection configuration special file.

Constructor Summary

Constructors

Constructor and Description
ExistDatabase()

Method Summary

Modifier and Type	Method and Description
String	backup() make a backup of entire database.
boolean	collectionExists(String collection) check whether a collection exists.
void	create(String name, String collection, String content) creates a new resource or updates the resource if it already exists.
void	createCollection(String collection) creates a new collection, non recursively.
String	getBackupDir() Return the dir that contains all backups.
protected org.xmldb.api.base.Collection	getCollection(String collection) helper method.
protected org.xmldb.api.modules.CollectionManagementService	getColman()
String	getConfigFile()
protected org.xmldb.api.base.Database	getDatabase()
protected org.exist.xmldb.DatabaseInstanceManager	getManager()
protected org.xmldb.api.modules.XPathQueryService	getQueryService()
protected org.xmldb.api.base.Collection	getRoot()
String	getRootCollection() returns the name of the root collection.
Map<String,Trigger>	getTriggerConf()
boolean	isRunning()
List<String>	list(String collection) list the content of a collection.
List<String>	listChildCollections(String collection) lists child collections.
String	read(String name, String collection) read a resource string xml.
void	registerTrigger(Trigger trigger, String collection) register a new trigger on a collection.
boolean	remove(String name, String collection) removes a resource.
void	removeCollection(String collection) remove a collection.
void	setBackupDir(String backupDir)
protected void	setColman(org.xmldb.api.modules.CollectionManagementService colman)
void	setConfigFile(String configFile)
protected void	setDatabase(org.xmldb.api.base.Database database)
protected void	setManager(org.exist.xmldb.DatabaseInstanceManager manager)
protected void	setQueryService(org.xmldb.api.modules.XPathQueryService queryService)
protected void	setRoot(org.xmldb.api.base.Collection root)
void	setTriggerConf(Map<String,Trigger> triggerConf)
void	start()
void	stop()
void	update(String name, String collection, String content) updates and already existing resource.
Iterator<String>	xquery(String query) Execute an xquery.
void	xupdate(String query)

Methods inherited from class java.lang.Object

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

Field Detail

COLLECTION_XCONF

public static final String COLLECTION_XCONF

eXist collection configuration special file.

See Also:

Constant Field Values

Constructor Detail

ExistDatabase

public ExistDatabase()

Method Detail

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

See Also:

Lifecycle.start()

getCollection

protected org.xmldb.api.base.Collection getCollection(String collection)
                                               throws org.xmldb.api.base.XMLDBException

helper method.

Parameters:

collection - collection name

Returns:

an eXist collection

Throws:

org.xmldb.api.base.XMLDBException - happens

create

public void create(String name,
                   String collection,
                   String content)
            throws org.xmldb.api.base.XMLDBException

creates a new resource or updates the resource if it already exists.

Specified by:

create in interface XMLDatabase

Parameters:

name - file name

collection - collection name

content - serialized xml string

Throws:

org.xmldb.api.base.XMLDBException - happens

See Also:

XMLDatabase.create(java.lang.String, java.lang.String, java.lang.String)

remove

public boolean remove(String name,
                      String collection)
               throws org.xmldb.api.base.XMLDBException

removes a resource.

Specified by:

remove in interface XMLDatabase

Parameters:

name - file name

collection - collection name

Returns:

false if the resource doesn't exist

Throws:

org.xmldb.api.base.XMLDBException - could happen

See Also:

XMLDatabase.remove(java.lang.String, java.lang.String)

update

public void update(String name,
                   String collection,
                   String content)
            throws org.xmldb.api.base.XMLDBException

updates and already existing resource.

Specified by:

update in interface XMLDatabase

Parameters:

name - file name

collection - collection name

content - serialized xml string

Throws:

org.xmldb.api.base.XMLDBException - fails if the resource doesn't exist

See Also:

XMLDatabase.update(java.lang.String, java.lang.String, java.lang.String)

read

public String read(String name,
                   String collection)
            throws org.xmldb.api.base.XMLDBException

read a resource string xml.

Specified by:

read in interface XMLDatabase

Parameters:

name - file name

collection - collection name

Returns:

null if the resource doesn't exist, otherwise it returns the xml string serialization

Throws:

org.xmldb.api.base.XMLDBException - happens

See Also:

XMLDatabase.read(java.lang.String, java.lang.String)

xquery

public Iterator<String> xquery(String query)
                        throws org.xmldb.api.base.XMLDBException

Execute an xquery.

Specified by:

xquery in interface XMLDatabase

Parameters:

query - xquery source

Returns:

a xmldb resultset object

Throws:

org.xmldb.api.base.XMLDBException - happens

See Also:

XMLDatabase.xquery(java.lang.String)

xupdate

public void xupdate(String query)
             throws org.xmldb.api.base.XMLDBException

Specified by:

xupdate in interface XMLDatabase

Throws:

org.xmldb.api.base.XMLDBException

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

See Also:

Lifecycle.stop()

collectionExists

public boolean collectionExists(String collection)
                         throws org.xmldb.api.base.XMLDBException

check whether a collection exists.

Specified by:

collectionExists in interface XMLDatabase

Parameters:

collection - collection name

Returns:

true if the collection exists

Throws:

org.xmldb.api.base.XMLDBException - happens

See Also:

XMLDatabase.collectionExists(java.lang.String)

createCollection

public void createCollection(String collection)
                      throws org.xmldb.api.base.XMLDBException

creates a new collection, non recursively.

Specified by:

createCollection in interface XMLDatabase

Parameters:

collection - collection name

Throws:

org.xmldb.api.base.XMLDBException - happens

See Also:

XMLDatabase.createCollection(java.lang.String)

removeCollection

public void removeCollection(String collection)
                      throws org.xmldb.api.base.XMLDBException

remove a collection.

Specified by:

removeCollection in interface XMLDatabase

Parameters:

collection - collection name

Throws:

org.xmldb.api.base.XMLDBException - happens also when the collection doesn't eXist

See Also:

XMLDatabase.removeCollection(java.lang.String)

getConfigFile

public String getConfigFile()

setConfigFile

public void setConfigFile(String configFile)

getBackupDir

public String getBackupDir()

Description copied from interface: XMLDatabase

Return the dir that contains all backups.

Specified by:

getBackupDir in interface XMLDatabase

Returns:

the path in which the Backup has been saved

setBackupDir

public void setBackupDir(String backupDir)

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

See Also:

useless contract with spring.

getDatabase

protected org.xmldb.api.base.Database getDatabase()

setDatabase

protected void setDatabase(org.xmldb.api.base.Database database)

getRoot

protected org.xmldb.api.base.Collection getRoot()

setRoot

protected void setRoot(org.xmldb.api.base.Collection root)

getManager

protected org.exist.xmldb.DatabaseInstanceManager getManager()

setManager

protected void setManager(org.exist.xmldb.DatabaseInstanceManager manager)

getQueryService

protected org.xmldb.api.modules.XPathQueryService getQueryService()

setQueryService

protected void setQueryService(org.xmldb.api.modules.XPathQueryService queryService)

getColman

protected org.xmldb.api.modules.CollectionManagementService getColman()

setColman

protected void setColman(org.xmldb.api.modules.CollectionManagementService colman)

getRootCollection

public String getRootCollection()

Description copied from interface: XMLDatabase

returns the name of the root collection.

Specified by:

getRootCollection in interface XMLDatabase

Returns:

collection name

listChildCollections

public List<String> listChildCollections(String collection)
                                  throws org.xmldb.api.base.XMLDBException

lists child collections.

Specified by:

listChildCollections in interface XMLDatabase

Parameters:

collection - parent collections

Returns:

list of collection names

Throws:

org.xmldb.api.base.XMLDBException - happens

See Also:

XMLDatabase.listChildCollections(java.lang.String)

list

public List<String> list(String collection)
                  throws org.xmldb.api.base.XMLDBException

list the content of a collection.

Specified by:

list in interface XMLDatabase

Parameters:

collection - parent collection

Returns:

list of resource names

Throws:

org.xmldb.api.base.XMLDBException - happens

See Also:

XMLDatabase.list(java.lang.String)

registerTrigger

public void registerTrigger(Trigger trigger,
                            String collection)
                     throws org.xmldb.api.base.XMLDBException

register a new trigger on a collection.

Specified by:

registerTrigger in interface XMLDatabase

Parameters:

trigger - trigger instance

collection - collection pattern

Throws:

org.xmldb.api.base.XMLDBException - happens

See Also:

XMLDatabase.registerTrigger(eu.dnetlib.xml.database.Trigger, java.lang.String)

getTriggerConf

public Map<String,Trigger> getTriggerConf()

setTriggerConf

public void setTriggerConf(Map<String,Trigger> triggerConf)

backup

public String backup()
              throws org.xmldb.api.base.XMLDBException,
                     org.exist.util.DatabaseConfigurationException

make a backup of entire database.

Specified by:

backup in interface XMLDatabase

Returns:

the path in which the Backup has been saved

Throws:

org.xmldb.api.base.XMLDBException - could happen

org.exist.util.DatabaseConfigurationException - could happen

See Also:

XMLDatabase.backup()