org.smartcomps.twister.common.persistence
Class XMLDataAccess

java.lang.Object
  |
  +--org.smartcomps.twister.common.persistence.XMLDataAccess

Direct Known Subclasses:

CorrelationXAO, VariableXAO

public class XMLDataAccess

extends java.lang.Object

Utility class containing main methods to create, update, delete or find XML document in Xindice. This class can be used directly or derived to implement more specific XMLDataAccess objects.

Note : paths must start with the '/' character

Constructor Summary

XMLDataAccess()

Method Summary

static void	cleanCollection(java.lang.String path) Removes all documents in a collection.
static org.xmldb.api.base.Collection	createCollection(org.xmldb.api.base.Collection parent, java.lang.String collectionName)
static void	deleteDocument(org.xmldb.api.base.Collection parent, java.lang.String docId)
static org.xmldb.api.base.Collection	getCollection(java.lang.String path)
static org.dom4j.Document	getDocument(org.xmldb.api.base.Collection coll, java.lang.String docId)
static org.dom4j.Document	getDocument(java.lang.String collectionPath, java.lang.String docId)
protected static org.dom4j.io.DOMReader	getDomReader()
static org.xmldb.api.base.Collection	getRootCollection()
static void	insertDocument(org.xmldb.api.base.Collection parent, java.lang.String docId, org.dom4j.Document document)
static java.util.List	queryDocument(org.xmldb.api.base.Collection parent, java.lang.String docId, java.lang.String query)
static java.lang.String	queryDocumentForValue(org.xmldb.api.base.Collection parent, java.lang.String docId, java.lang.String query)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLDataAccess

public XMLDataAccess()

Method Detail

getRootCollection

public static org.xmldb.api.base.Collection getRootCollection()
                                                       throws XMLSessionException

XMLSessionException

getCollection

public static org.xmldb.api.base.Collection getCollection(java.lang.String path)
                                                   throws XMLSessionException

XMLSessionException

getDocument

public static org.dom4j.Document getDocument(java.lang.String collectionPath,
                                             java.lang.String docId)
                                      throws XMLSessionException,
                                             FinderException

XMLSessionException

FinderException

getDocument

public static org.dom4j.Document getDocument(org.xmldb.api.base.Collection coll,
                                             java.lang.String docId)
                                      throws XMLSessionException,
                                             FinderException

XMLSessionException

FinderException

queryDocumentForValue

public static java.lang.String queryDocumentForValue(org.xmldb.api.base.Collection parent,
                                                     java.lang.String docId,
                                                     java.lang.String query)
                                              throws XMLSessionException,
                                                     FinderException

XMLSessionException

FinderException

queryDocument

public static java.util.List queryDocument(org.xmldb.api.base.Collection parent,
                                           java.lang.String docId,
                                           java.lang.String query)
                                    throws XMLSessionException,
                                           FinderException

XMLSessionException

FinderException

createCollection

public static org.xmldb.api.base.Collection createCollection(org.xmldb.api.base.Collection parent,
                                                             java.lang.String collectionName)
                                                      throws XMLSessionException

XMLSessionException

insertDocument

public static void insertDocument(org.xmldb.api.base.Collection parent,
                                  java.lang.String docId,
                                  org.dom4j.Document document)
                           throws XMLSessionException

XMLSessionException

deleteDocument

public static void deleteDocument(org.xmldb.api.base.Collection parent,
                                  java.lang.String docId)
                           throws XMLSessionException

XMLSessionException

cleanCollection

public static void cleanCollection(java.lang.String path)
                            throws XMLSessionException

Removes all documents in a collection. Does nothing if no collection can be found at the provided path.

Parameters:

path - to the collection

Throws:

XMLSessionException

getDomReader

protected static org.dom4j.io.DOMReader getDomReader()