public interface DocumentUnmarshaller
Document
data from its preserved state that
has been created using a DocumentMarshaller
. The unmarshaller implementation must match
the marshaller implementation that was used to create the marshaled data.Modifier and Type | Field and Description |
---|---|
static String |
DOCUMENT_META_DATA
Property key for the imported document's meta-data.
|
static String |
DOCUMENT_NAME
Property key for the imported document's name.
|
static String |
DOCUMENT_USER_PROPERTIES
Property key for the imported document's user-properties
|
Modifier and Type | Method and Description |
---|---|
ReaderControls |
getReaderControls()
Get the
ReaderControls to be used during unmarshalling. |
void |
setReaderControls(ReaderControls readerControls)
Set the
ReaderControls to be used during unmarshalling. |
void |
unmarshal(Document document,
InputStream is,
int targetLocation,
boolean mergeProperties,
boolean mergeMetaData)
Unmarshal the preserved state of the document contained in the given input stream and merge the
recovered data into the given document.
|
Document |
unmarshal(InputStream is)
Unmarshal the preserved state of the document contained in the given input stream and return the
Document . |
Document |
unmarshalLightweight(InputStream is)
Unmarshal only the preserved user-properties, metadata and name of the document contained in the
given input stream and return the
Document . |
static final String DOCUMENT_USER_PROPERTIES
static final String DOCUMENT_META_DATA
static final String DOCUMENT_NAME
Document unmarshal(InputStream is) throws IOException, JadiceException
Document
.is
- stream from which to read the documentIOException
- in case of read errorsJadiceException
- in case of other problemsvoid unmarshal(Document document, InputStream is, int targetLocation, boolean mergeProperties, boolean mergeMetaData) throws IOException, JadiceException
document
- the Document into which to merge the datais
- stream from which to read the documenttargetLocation
- the page index at which to insert recovered pagesmergeProperties
- whether to merge document user-propertiesmergeMetaData
- whether to merge document meta-dataIOException
- in case of read errorsJadiceException
- in case of other problemsDocument unmarshalLightweight(InputStream is) throws IOException
Document
.is
- stream from which to read the documentIOException
- in case of read errorsvoid setReaderControls(ReaderControls readerControls)
ReaderControls
to be used during unmarshalling. Whether the
ReaderSettings
contained therein are used or not may depend on the file format and
unmarshaller implementation.
In order to modify a particular set of ReaderSettings
it is preferable to use
getReaderControls()
.ProcessingControls.getSettings(Class)
instead of
using this method. Instead, this method should only be used to replace all controls with an
already existing set of controls.readerControls
- the instance to be setReaderControls getReaderControls()
ReaderControls
to be used during unmarshalling. Whether the
ReaderSettings
contained therein are used or not may depend on the file format and
unmarshaller implementation.Copyright © 2024 levigo holding gmbh. All rights reserved.