org.semanticdesktop.aperture.extractor
Interface Extractor

All Known Implementing Classes:

ExcelExtractor, HtmlExtractor, JpgExtractor, MimeExtractor, OfficeExtractor, OpenDocumentExtractor, OpenXmlExtractor, PdfExtractor, PlainTextExtractor, PoiOOXmlExtractor, PowerPointExtractor, PresentationsExtractor, PublisherExtractor, QuattroExtractor, RtfExtractor, ThreadedExtractorWrapper, VisioExtractor, WordExtractor, WordPerfectExtractor, WorksExtractor, XmlExtractor, XMPExtractor

public interface Extractor

Extractors extract information from binary streams such as document full-text, titles, authors and other metadata that may be supported by the format. Extractors are typically specific for a single MIME type or a number of closely related MIME types.

Method Summary

void	extract(URI id, InputStream stream, Charset charset, String mimeType, RDFContainer result) Extracts full-text and metadata from the specified binary stream and stores the extracted information as RDF statements in the specified RDFContainer.

Method Detail

extract

void extract(URI id,
             InputStream stream,
             Charset charset,
             String mimeType,
             RDFContainer result)
             throws ExtractorException

Extracts full-text and metadata from the specified binary stream and stores the extracted information as RDF statements in the specified RDFContainer. The optionally specified Charset and MIME type can be used to direct how the stream should be parsed.

The specified InputStream is expected to already use some kind of buffering so that the Extractors are not required to internally buffer bytes to improve performance.

Parameters:

id - the URI identifying the object (e.g. a file or web page) from which the stream was obtained. The generated statements should describe this URI.

stream - the InputStream delivering the raw bytes.

charset - the charset in which the inputstream is encoded (optional).

mimeType - the MIME type of the passed stream (optional).

result - the container in which this Extractor can put its created RDF statements.

Throws:

ExtractorException - in case of any error during the extraction process.