alma.aedf
Class Archiver

java.lang.Object
  |
  +--alma.acs.component.client.ComponentClient
        |
        +--alma.aedf.Archiver

public class Archiver

extends alma.acs.component.client.ComponentClient

The central class of this package, to store, retrieve, update and delete VO Tables XML documents to/from the XML store.

Author:

caillat

Constructor Summary

Archiver(java.util.logging.Logger logger, java.lang.String managerLoc)
Creates an Archiver, i.e. a connection to a database and a collection of methods to store, retrieve, update, delete, list XML documents stored in this databse.

Method Summary

java.lang.String[]	getAllUIDs()
java.lang.String[]	getUIDs(java.lang.String query)
java.util.Hashtable	getUIDsAndTypes()
java.lang.String	query(java.lang.String entityName, java.lang.String aQuery, int maxRes)
java.lang.String	retrieve(java.lang.String uid) Returns an XML document stored in the archive given its UID.
void	setup()
java.lang.String	store(java.lang.String xmlString) Store an XML document in the archive.
void	update(java.lang.String uid, java.lang.String xmlString)

Methods inherited from class alma.acs.component.client.ComponentClient

getContainerServices, getORB, tearDown

Methods inherited from class java.lang.Object

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

Constructor Detail

Archiver

public Archiver(java.util.logging.Logger logger,
                java.lang.String managerLoc)
         throws ArchiverException,
                java.lang.Exception

Creates an Archiver, i.e. a connection to a database and a collection of methods to store, retrieve, update, delete, list XML documents stored in this databse.

Parameters:

logger - A logger

managerLoc - The manager location.

Throws:

ArchiverException

java.lang.Exception

Method Detail

setup

public void setup()
           throws alma.acs.container.ContainerException,
                  alma.xmlstore.ArchiveConnectionPackage.ArchiveException,
                  alma.xmlstore.ArchiveConnectionPackage.UserDoesNotExistException,
                  alma.xmlstore.ArchiveConnectionPackage.PermissionException

alma.acs.container.ContainerException

alma.xmlstore.ArchiveConnectionPackage.ArchiveException

alma.xmlstore.ArchiveConnectionPackage.UserDoesNotExistException

alma.xmlstore.ArchiveConnectionPackage.PermissionException

query

public java.lang.String query(java.lang.String entityName,
                              java.lang.String aQuery,
                              int maxRes)

store

public java.lang.String store(java.lang.String xmlString)
                       throws alma.xmlstore.ArchiveConnectionPackage.ArchiveException

Store an XML document in the archive. The XML document is assumed to be conform with the VOTable schema. Returns the UID of the archived document.

Parameters:

xmlString - the XML document to store

Returns:

the UID of the stored document.

Throws:

alma.xmlstore.ArchiveConnectionPackage.ArchiveException

retrieve

public java.lang.String retrieve(java.lang.String uid)
                          throws alma.xmlstore.ArchiveConnectionPackage.ArchiveException

Returns an XML document stored in the archive given its UID.

Parameters:

uid - the uid of the document to retrieve,

Returns:

the XML document.

Throws:

alma.xmlstore.ArchiveConnectionPackage.ArchiveException

update

public void update(java.lang.String uid,
                   java.lang.String xmlString)
            throws alma.xmlstore.ArchiveConnectionPackage.ArchiveException

alma.xmlstore.ArchiveConnectionPackage.ArchiveException

getUIDs

public java.lang.String[] getUIDs(java.lang.String query)
                           throws alma.xmlstore.ArchiveConnectionPackage.ArchiveException

alma.xmlstore.ArchiveConnectionPackage.ArchiveException

getAllUIDs

public java.lang.String[] getAllUIDs()
                              throws alma.xmlstore.ArchiveConnectionPackage.ArchiveException

alma.xmlstore.ArchiveConnectionPackage.ArchiveException

getUIDsAndTypes

public java.util.Hashtable getUIDsAndTypes()
                                    throws alma.xmlstore.ArchiveConnectionPackage.ArchiveException

alma.xmlstore.ArchiveConnectionPackage.ArchiveException