Qizx fe-4.4p2 API

com.qizx.api
Interface NonXMLDocument

All Superinterfaces:
LibraryMember

public interface NonXMLDocument
extends LibraryMember

Represents a non-XML Document stored in a XML Library.

Its contents is a plain sequence of bytes, and can be read through a sequential Stream.

When importing in the database (using Library.importNonXMLDocument(java.lang.String, boolean, java.io.InputStream)) compression can be specified. Compression is recommended for text-like data and not recommended for already compressed data such as images.

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

It is recommended to set property "mime-type" to the value of the data's mime-type, so that the contents can be later properly rendered.

See Also:
LibraryMember

Field Summary
 
Fields inherited from interface com.qizx.api.LibraryMember
COLLECTION, DOCUMENT, NATURE, NONXMLDOC, PATH
 
Method Summary
 boolean isCompressed()
          Returns true if the contained data is compressed.
 InputStream open()
          Opens for sequential read.
 long size()
          Returns the uncompressed size in bytes of the contained data.
 
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

size

long size()
          throws DataModelException
Returns the uncompressed size in bytes of the contained data.

Throws:
DataModelException

isCompressed

boolean isCompressed()
                     throws DataModelException
Returns true if the contained data is compressed.

Throws:
DataModelException

open

InputStream open()
                 throws DataModelException
Opens for sequential read.

Returns:
a InputStream allowing to read the binary contents.
Throws:
DataModelException - if the Blob is deleted; common causes

© 2010 Axyana Software