|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.viewer.CMBStreamingDocServices
CMBStreamingDocServices is very similar to the CMBDocumentServices bean (and is, in fact, used by CMBDocumentServices). It's interfaces are based on streams rather than a reference to a CMBItem or other non-visual beans. This class may be used without need for a connection to a federated database or content server, such as in a stand-alone file viewer.
CMBDocumentServices
, Serialized FormFields inherited from interface com.ibm.mm.viewer.CMBViewerConstants |
DEFAULT_PAGE_NUMBER, ROTATE_0, ROTATE_180, ROTATE_270, ROTATE_90 |
Constructor Summary | |
CMBStreamingDocServices(CMBStreamingDocServicesCallbacks callbacks,
java.util.Properties engineProperties)
Constructs CMBStreamingDocServices. |
Method Summary | |
void |
dropAllDocuments()
Terminates processing of all documents. |
void |
dropDocument(CMBDocument document)
Terminates processing of a document. |
protected void |
finalize()
Overridden to cause all documents and engines to be dropped, freeing resources. |
java.util.Properties |
getConversionProperties()
Returns the conversion properties. |
CMBDocument |
getDocumentFromHandle(java.lang.Object hItem)
|
CMBDocument[] |
getDocuments()
Returns the documents being processed. |
CMBDocument |
getDocuments(int index)
Returns a particular document being processed. |
java.lang.Object |
getItemHandle(CMBDocument document)
Returns the handle related to a document. |
java.lang.String[] |
getPreferredFormats()
Returns the preferred formats for converted documents. |
java.lang.String[] |
getPreferredPageFormats()
Returns the preferred page formats for converted pages of documents. |
CMBDocument |
loadDocument(java.io.InputStream firstPart,
int firstPartSize,
int numberOfParts,
java.lang.String docMimeType,
java.lang.String firstPartMimeType,
java.io.InputStream annotations,
java.io.InputStream resources)
Loads a document into document services. |
CMBDocument |
loadDocument(java.io.InputStream firstPart,
int numberOfParts,
java.lang.String docMimeType,
java.lang.String firstPartMimeType,
java.io.InputStream annotations,
java.io.InputStream resources)
Loads a document into document services. |
void |
setConversionProperties(java.util.Properties properties)
Sets the conversion properties. |
void |
setItemHandle(CMBDocument document,
java.lang.Object itemHandle)
Sets a handle to a document. |
void |
setPreferredFormats(java.lang.String[] formats)
Sets the preferred formats for converted documents, in the order of most preferred to least preferred. |
void |
setPreferredPageFormats(java.lang.String[] pageFormats)
Sets the preferred page formats for converted pages of documents, in the order of most preferred to least preferred. |
void |
terminate()
Terminates all the engines. |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CMBStreamingDocServices(CMBStreamingDocServicesCallbacks callbacks, java.util.Properties engineProperties)
callbacks
- implementation of CMBStreamingDocServicesCallbacks with methods
that are called to retrieve additional document parts.engineProperties
- properties object defining the engines classes and their
properties. See CMBDocumentServices for details.Method Detail |
public CMBDocument[] getDocuments()
public CMBDocument getDocuments(int index) throws java.lang.ArrayIndexOutOfBoundsException
public java.lang.String[] getPreferredFormats()
public void setPreferredFormats(java.lang.String[] formats)
formats
- the MIME types for the preferred formats.public java.lang.String[] getPreferredPageFormats()
public void setPreferredPageFormats(java.lang.String[] pageFormats)
formats
- the MIME types for the preferred formats.public java.util.Properties getConversionProperties()
setConversionProperties
public void setConversionProperties(java.util.Properties properties)
public CMBDocument loadDocument(java.io.InputStream firstPart, int numberOfParts, java.lang.String docMimeType, java.lang.String firstPartMimeType, java.io.InputStream annotations, java.io.InputStream resources) throws java.io.IOException, java.lang.ClassNotFoundException, java.lang.IllegalAccessException, java.lang.InstantiationException
firstPart
- a stream containing the first part of the document.numberOfParts
- the number of parts of the document.docMimeType
- the MIME content type of the document.firstPartMimeType
- the MIME content type of the first part of the document.annotations
- a stream containing annotations for the document pages.resources
- a stream containing resources for the document.public CMBDocument loadDocument(java.io.InputStream firstPart, int firstPartSize, int numberOfParts, java.lang.String docMimeType, java.lang.String firstPartMimeType, java.io.InputStream annotations, java.io.InputStream resources) throws java.io.IOException, java.lang.ClassNotFoundException, java.lang.IllegalAccessException, java.lang.InstantiationException
firstPart
- a stream containing the first part of the document.firstPartSize
- the size of the firstPart stream.numberOfParts
- the number of parts of the documentdocMimeType
- the MIME content type of the documentfirstPartMimeType
- the MIME content type of the first part of the document.annotations
- a stream containing annotations for the document pages.resources
- a stream containing resources for the document.public void dropDocument(CMBDocument document)
document
- the document being terminated.public void dropAllDocuments()
public void setItemHandle(CMBDocument document, java.lang.Object itemHandle)
document
- the document whose handle is being set.itemHandle
- the value for the handle.public java.lang.Object getItemHandle(CMBDocument document)
document
- the document whose handle is being retrieved.public CMBDocument getDocumentFromHandle(java.lang.Object hItem)
public void terminate()
protected void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |