alma.asdm.Archiver Class Reference

List of all members.

---

Detailed Description

Author:

caillat

Public Member Functions
	Archiver (ContainerServices containerServices) throws Exception
	Creates an Archiver, i.e.
String	getID () throws NotAvailable
	Returns an Archive uid.
String[]	getUIDs (String query, String schema) throws ArchiveException
	Returns an array of all the Archive uids of stored document having a given schema and verifying a given XPath expression.
String	query (String aQuery, String schema, int maxRes)
	Returns a string containing pieces of XML code verifying an XPath expression in the documents stored in the Archive with a given schema.
String	retrieve (String uid) throws ArchiveException
	Returns an XML document stored in the archive given its Archive uid.
String	store (String xmlString, String schema) throws ArchiveException
	Stores an XML document in the archive.
void	store (String xmlString, String schema, String uid) throws ArchiveException
	Stores an XML document in the archive.
void	update (String uid, String xmlString) throws ArchiveException
	Updates a XML document archived with a given Archive uid.
void	binStore (String uid, byte[] data) throws ArchiveException
byte[]	binRetrieve (String uid) throws ArchiveException
void	done () throws ArchiveInternalError
void	finalize () throws ArchiveInternalError
Package Attributes
Administrative	m_admin

---

Constructor & Destructor Documentation

alma.asdm.Archiver.Archiver

(

ContainerServices

containerServices

)

throws Exception

Creates an Archiver, i.e.

a connection to a database and a collection of methods to store, retrieve, update, list XML documents stored in this databse.

Parameters:

containerServices

the services of the container providing the components related to the Archive.

Exceptions:

Exception

---

Member Function Documentation

String alma.asdm.Archiver.getID

(

)

throws NotAvailable

Returns an Archive uid.

Returns:

a string containing an Archive uid.

Exceptions:

NotAvailable

String [] alma.asdm.Archiver.getUIDs	(	String	query,
		String	schema
	)			throws ArchiveException

Returns an array of all the Archive uids of stored document having a given schema and verifying a given XPath expression.

Parameters:

	query	an XPath expression
	schema	the name of a schema

Returns:

an array of strings containing Archive uids.

Exceptions:

ArchiveException

String alma.asdm.Archiver.query	(	String	aQuery,
		String	schema,
		int	maxRes
	)

Returns a string containing pieces of XML code verifying an XPath expression in the documents stored in the Archive with a given schema.

The maximum of number of results is defined by a parameter.

Parameters:

	aQuery	an XPath expression
	schema	a schema's name
	maxRes	the maximum number of results to be returned

Returns:

a string obtained by concatenating all the results.

String alma.asdm.Archiver.retrieve

(

String

uid

)

throws ArchiveException

Returns an XML document stored in the archive given its Archive uid.

Parameters:

uid

the Archive uid of the document to retrieve,

Returns:

the XML document.

Exceptions:

ArchiveException

String alma.asdm.Archiver.store	(	String	xmlString,
		String	schema
	)			throws ArchiveException

Stores an XML document in the archive.

The XML document is assumed to be conform with the schema whose name is passed as a parameter. Returns the Archive uid assigned to the archived document.

Parameters:

xmlString

the XML document to store

Returns:

a string containing the Archive uid of the stored document.

Exceptions:

ArchiveException

void alma.asdm.Archiver.store	(	String	xmlString,
		String	schema,
		String	uid
	)			throws ArchiveException

Stores an XML document in the archive.

The XML document is assumed to be conform with the schema whose name is passed in argument.

Parameters:

	xmlString	the XML document to store
	schema	the name of the schema
	archive	ID assigned to this document

Exceptions:

ArchiveException

void alma.asdm.Archiver.update	(	String	uid,
		String	xmlString
	)			throws ArchiveException

Updates a XML document archived with a given Archive uid.

Parameters:

	uid	the Archive uid of the document to update,
	xmlString	the new content of the document.

Exceptions:

ArchiveException

---

The documentation for this class was generated from the following file:

• Archiver.java

---