ModeShape Distribution 3.0.0.Alpha6

org.modeshape.jcr.api.text
Class TextExtractor

java.lang.Object
  extended by org.modeshape.jcr.api.text.TextExtractor
Direct Known Subclasses:
NoOpTextExtractor, TextExtractors

public abstract class TextExtractor
extends Object

An abstraction for components that are able to extract text content from an input stream. //TODO author=Horia Chiorean date=2/9/12 description=Refine this class when porting/implementing extractors


Nested Class Summary
static interface TextExtractor.Context
           
 
Constructor Summary
TextExtractor()
           
 
Method Summary
abstract  void extractFrom(InputStream stream, TextExtractorOutput output, TextExtractor.Context context)
          Sequence the data found in the supplied stream, placing the output information into the supplied map.
protected  Logger getLogger()
           
protected  void setLogger(Logger logger)
           
abstract  boolean supportsMimeType(String mimeType)
          Determine if this extractor is capable of processing content with the supplied MIME type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextExtractor

public TextExtractor()
Method Detail

supportsMimeType

public abstract boolean supportsMimeType(String mimeType)
Determine if this extractor is capable of processing content with the supplied MIME type.

Parameters:
mimeType - the MIME type; never null
Returns:
true if this extractor can process content with the supplied MIME type, or false otherwise.

extractFrom

public abstract void extractFrom(InputStream stream,
                                 TextExtractorOutput output,
                                 TextExtractor.Context context)
                          throws IOException
Sequence the data found in the supplied stream, placing the output information into the supplied map.

ModeShape's SequencingService determines the sequencers that should be executed by monitoring the changes to one or more workspaces that it is monitoring. Changes in those workspaces are aggregated and used to determine which sequencers should be called. If the sequencer implements this interface, then this method is called with the property that is to be sequenced along with the interface used to register the output. The framework takes care of all the rest.

Parameters:
stream - the stream with the data to be sequenced; never null
output - the output from the sequencing operation; never null
context - the context for the sequencing operation; never null
Throws:
IOException - if there is a problem reading the stream

setLogger

protected final void setLogger(Logger logger)

getLogger

protected final Logger getLogger()

ModeShape Distribution 3.0.0.Alpha6

Copyright © 2008-2012 JBoss, a division of Red Hat. All Rights Reserved.