xmlstore::Operational Interface Reference

import "archive_xmlstore_if.idl";

Inheritance diagram for xmlstore::Operational:

[legend]Collaboration diagram for xmlstore::Operational:

[legend]List of all members.

Public Member Functions
boolean	exists (in URI identifier) raises (ArchiveInternalError, NotFound, MalformedURI, DirtyEntity)
void	store (in xmlentity::XmlEntityStruct entity) raises (ArchiveInternalError, IllegalEntity)
void	update (in xmlentity::XmlEntityStruct entity) raises (ArchiveInternalError, IllegalEntity)
void	forceUpdate (in xmlentity::XmlEntityStruct entity) raises (ArchiveInternalError, IllegalEntity)
void	updateXML (in URI uid, in string schema, in string newChild) raises (ArchiveInternalError, IllegalEntity, MalformedURI, NotYetThere)
xmlentity::XmlEntityStruct	retrieve (in URI identifier) raises (ArchiveInternalError, NotFound, MalformedURI, DirtyEntity)
StringSeq	retrieveFragment (in URI identifier, in string id) raises (ArchiveInternalError, NotFound, MalformedURI, DirtyEntity)
xmlentity::XmlEntityStruct	updateRetrieve (in URI identifier) raises (ArchiveInternalError, NotFound, MalformedURI, DirtyEntity)
xmlentity::XmlEntityStruct	retrieveDirty (in URI identifier) raises (ArchiveInternalError, NotFound, MalformedURI)
void	delete (in URI identifier) raises (ArchiveInternalError, NotFound, MalformedURI)
void	undelete (in URI identifier) raises (ArchiveInternalError, NotFound, MalformedURI)
StatusStruct	status (in URI identifier) raises (ArchiveInternalError, NotFound, MalformedURI)
Cursor	query (in string query, in string schema) raises (ArchiveInternalError)
Cursor	queryContent (in string query, in string schema) raises (ArchiveInternalError)
Cursor	queryDirty (in string query, in string schema) raises (ArchiveInternalError)
URISeq	queryUIDs (in string query, in string schema) raises (ArchiveInternalError)
URISeq	queryUIDsDirty (in string query, in string schema) raises (ArchiveInternalError)
URISeq	queryRecent (in string schemaname, in string timestamp) raises (ArchiveInternalError)
void	close () raises (ArchiveInternalError)

---

Detailed Description

This interface contains the core functionality of the XMLstore: store, query and retrieve XML documents (entities). An entity is a set of XML documents: In this way, versioning is implemented. The normal behaviour is that only the latest document is referenced. Some methods also allow access to older versions. XML entities are also associated with meta data.

---

Member Function Documentation

void xmlstore::Operational::close (   )  raises (ArchiveInternalError)

TODO: update comment, is wrong. Shuts down the Archive. Replaced by close in Administrative..

void xmlstore::Operational::delete (  in URI  identifier  )  raises (ArchiveInternalError, NotFound, MalformedURI)

Flags an entity as deleted. Deleted entities can not be updated, retrieved, or queried.

boolean xmlstore::Operational::exists (  in URI  identifier  )  raises (ArchiveInternalError, NotFound, MalformedURI, DirtyEntity)

Checks whether an entity with given UID already exists in Archive. Returns true, if this is the case.

void xmlstore::Operational::forceUpdate (  in xmlentity::XmlEntityStruct  entity  )  raises (ArchiveInternalError, IllegalEntity)

Updates an existing entity. No timestamp consistency check is performed.

Cursor xmlstore::Operational::query (  in string  query, in string  schema )  raises (ArchiveInternalError)

Returns a cursor containing all entities (latest version) matching the XPath query passed over in the parameter query. Only entities associated with the schema name handed over in parameter schema are returned. Entities flagged as dirty are not returned. Due to a problem in Oracle XPath handling, this method does not handle XPath expressions querying for content (eg. a/attribute::b) as query *result* correctly. For these queries you'll have to use the dedicated queryContent method.

Cursor xmlstore::Operational::queryContent (  in string  query, in string  schema )  raises (ArchiveInternalError)

Same as query, but is able to handle content queries (eg. a/b/text() ) correctly. Do not use this method for non-content queries (eg. a[]/c ).

Cursor xmlstore::Operational::queryDirty (  in string  query, in string  schema )  raises (ArchiveInternalError)

Same as query, but entities flagged as dirty are returned, too.

URISeq xmlstore::Operational::queryRecent (  in string  schemaname, in string  timestamp )  raises (ArchiveInternalError)

Returns UIDs of all documents belonging to specified schema which are newer (latest version) then timestamp. Entities flagged as dirty are not returned.

URISeq xmlstore::Operational::queryUIDs (  in string  query, in string  schema )  raises (ArchiveInternalError)

Same as query, but returns a sequence of UniqueIdentifiers for the matching documents instead of a cursor (which contains the documents itself). Entities flagged as dirty are not returned.

URISeq xmlstore::Operational::queryUIDsDirty (  in string  query, in string  schema )  raises (ArchiveInternalError)

Same as queryUIDs, but entities flagged dirty are returned, too.

xmlentity::XmlEntityStruct xmlstore::Operational::retrieve (  in URI  identifier  )  raises (ArchiveInternalError, NotFound, MalformedURI, DirtyEntity)

Retrieves an entity (latest version) from the Archive. If the entity is marked as dirty an exception is thrown.

xmlentity::XmlEntityStruct xmlstore::Operational::retrieveDirty (  in URI  identifier  )  raises (ArchiveInternalError, NotFound, MalformedURI)

retrieves an entity even if it flagged as dirty.

StringSeq xmlstore::Operational::retrieveFragment (  in URI  identifier, in string  id )  raises (ArchiveInternalError, NotFound, MalformedURI, DirtyEntity)

Retrieves part of an entity (latest version). The part is specified by the XPath expression handed over in the parameter id.

StatusStruct xmlstore::Operational::status (  in URI  identifier  )  raises (ArchiveInternalError, NotFound, MalformedURI)

Retrieves meta information about an entity.

void xmlstore::Operational::store (  in xmlentity::XmlEntityStruct  entity  )  raises (ArchiveInternalError, IllegalEntity)

Stores a new entity.

void xmlstore::Operational::undelete (  in URI  identifier  )  raises (ArchiveInternalError, NotFound, MalformedURI)

Flags an entity as undeleted

void xmlstore::Operational::update (  in xmlentity::XmlEntityStruct  entity  )  raises (ArchiveInternalError, IllegalEntity)

Updates an existing entity. The timestamp that is part of the XmlEntityStruct is compared to the latest timestamp of that entity in the Archive. If the timestamps mismatch an exception is thrown.

xmlentity::XmlEntityStruct xmlstore::Operational::updateRetrieve (  in URI  identifier  )  raises (ArchiveInternalError, NotFound, MalformedURI, DirtyEntity)

Retrieves an entity and flags it as dirty for updating it.

void xmlstore::Operational::updateXML (  in URI  uid, in string  schema, in string  newChild )  raises (ArchiveInternalError, IllegalEntity, MalformedURI, NotYetThere)

Performs an incremental update on the XML document stored under uid belonging to schema schema: The XML string newChild as appended as the last child of the root element in the database. No history information is maintained in this case for this update operation (as opposed to the normal update).

---

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

• archive_xmlstore_if.idl

---