eu.dnetlib.xml.database

Interface XMLDatabase

All Known Implementing Classes:

ExistDatabase, PersistentExistDatabase, TemporaryExistDatabase

public interface XMLDatabase

xmldb API is ugly. This is a thin wrapper to the xmldb API with focus on the primary operations used by dnet

Author:

marko

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.
String	getRootCollection() returns the name of the root collection.
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	update(String name, String collection, String content) updates and already existing resource.
Iterator<String>	xquery(String xquery) Execute an xquery.
void	xupdate(String query)

Method Detail

create

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.

Parameters:

name - file name

collection - collection name

content - serialized xml string

Throws:

org.xmldb.api.base.XMLDBException - happens

update

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

updates and already existing resource.

Parameters:

name - file name

collection - collection name

content - serialized xml string

Throws:

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

remove

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

removes a resource.

Parameters:

name - file name

collection - collection name

Returns:

false if the resource doesn't exist

Throws:

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

read

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

read a resource string xml.

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

xquery

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

Execute an xquery.

Parameters:

xquery - xquery source

Returns:

a xmldb resultset object

Throws:

org.xmldb.api.base.XMLDBException - happens

createCollection

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

creates a new collection, non recursively.

Parameters:

collection - collection name

Throws:

org.xmldb.api.base.XMLDBException - happens

removeCollection

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

remove a collection.

Parameters:

collection - collection name

Throws:

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

xupdate

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

Throws:

org.xmldb.api.base.XMLDBException

collectionExists

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

check whether a collection exists.

Parameters:

collection - collection name

Returns:

true if the collection exists

Throws:

org.xmldb.api.base.XMLDBException - happens

listChildCollections

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

lists child collections.

Parameters:

collection - parent collections

Returns:

list of collection names

Throws:

org.xmldb.api.base.XMLDBException - happens

list

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

list the content of a collection.

Parameters:

collection - parent collection

Returns:

list of resource names

Throws:

org.xmldb.api.base.XMLDBException - happens

getRootCollection

String getRootCollection()

returns the name of the root collection.

Returns:

collection name

registerTrigger

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

register a new trigger on a collection.

Parameters:

trigger - trigger instance

collection - collection pattern

Throws:

org.xmldb.api.base.XMLDBException - happens

backup

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

make a backup of entire database.

Returns:

the path in which the Backup has been saved

Throws:

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

org.exist.util.DatabaseConfigurationException - could happen

getBackupDir

String getBackupDir()

Return the dir that contains all backups.

Returns:

the path in which the Backup has been saved