public interface Embedder extends Serializable
Modifier and Type | Method and Description |
---|---|
void |
embed(Metadata metadata,
InputStream originalStream,
OutputStream outputStream,
ParseContext context)
Embeds related document metadata from the given metadata object into the
given output stream.
|
Set<MediaType> |
getSupportedEmbedTypes(ParseContext context)
Returns the set of media types supported by this embedder when used with
the given parse context.
|
Set<MediaType> getSupportedEmbedTypes(ParseContext context)
The name differs from the precedence of Parser.getSupportedTypes(ParseContext)
so that parser implementations may also choose to implement this interface.
context
- parse contextvoid embed(Metadata metadata, InputStream originalStream, OutputStream outputStream, ParseContext context) throws IOException, TikaException
The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.
Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.
In general implementations should favor preserving the source file's metadata unless an update to a field is explicitly defined in the Metadata object. More specifically:
metadata
- document metadata (input and output)originalStream
- the document stream (input)outputStream
- the output stream to write the metadata embedded data tocontext
- parse contextIOException
- if the document stream could not be readTikaException
- if the document could not be parsedCopyright © 2007–1969 The Apache Software Foundation. All rights reserved.