com.qizx.api
Interface Document

All Superinterfaces:

LibraryMember

public interface Document

extends LibraryMember

Represents a well-formed XML Document stored in a XML Library. The tree structure of a Document can be traversed and queried using the XPath/XQuery language.

As a LibraryMember, it can have searchable properties (aka metadata).

See Also:

LibraryMember

Field Summary

Fields inherited from interface com.qizx.api.LibraryMember

COLLECTION, DOCUMENT, NATURE, PATH

Method Summary

XMLPullStream	export() Streaming export in pull mode.
void	export(XMLPushStream output) Streaming export in push mode.
Node	getDocumentNode() Returns the root Node of the document, of type document-node().

Methods inherited from interface com.qizx.api.LibraryMember

contains, copyTo, delete, exists, getIntegerProperty, getLibrary, getName, getParent, getParentPath, getPath, getProperty, getPropertyNames, hasProperty, isCollection, isDocument, lock, removeProperty, renameTo, setIntegerProperty, setProperty

Method Detail

getDocumentNode

public Node getDocumentNode()
                     throws DataModelException

Returns the root Node of the document, of type document-node().

Returns:

a node of type document-node(), root of the document.

Throws:

DataModelException - if the document is deleted; common causes

export

public XMLPullStream export()
                     throws DataModelException

Streaming export in pull mode.

Returns:

a XMLPullStream iterator allowing to extract the document contents in "pull" style.

Throws:

DataModelException - if the document is deleted; common causes

export

public void export(XMLPushStream output)
            throws DataModelException

Streaming export in push mode.

Parameters:

output - an object implementing the XMLPushStream interface typically XMLSerializer, PushStreamToSAX, PushStreamToDOM.

Throws:

DataModelException - if the document is deleted; common causes