org.apache.tika.parser
Class ParserDecorator

java.lang.Object
  extended by org.apache.tika.parser.ParserDecorator
All Implemented Interfaces:
java.io.Serializable, Parser
Direct Known Subclasses:
ParserPostProcessor

public class ParserDecorator
extends java.lang.Object
implements Parser

Decorator base class for the Parser interface. This class simply delegates all parsing calls to an underlying decorated parser instance. Subclasses can provide extra decoration by overriding the parse method.

See Also:
Serialized Form

Constructor Summary
ParserDecorator(Parser parser)
          Creates a decorator for the given parser.
 
Method Summary
 java.util.Set<MediaType> getSupportedTypes(ParseContext context)
          Delegates the method call to the decorated parser.
 Parser getWrappedParser()
          Gets the parser wrapped by this ParserDecorator
 void parse(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata)
          Deprecated. This method will be removed in Apache Tika 1.0.
 void parse(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata, ParseContext context)
          Delegates the method call to the decorated parser.
static Parser withTypes(Parser parser, java.util.Set<MediaType> types)
          Decorates the given parser so that it always claims to support parsing of the given media types.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParserDecorator

public ParserDecorator(Parser parser)
Creates a decorator for the given parser.

Parameters:
parser - the parser instance to be decorated
Method Detail

withTypes

public static final Parser withTypes(Parser parser,
                                     java.util.Set<MediaType> types)
Decorates the given parser so that it always claims to support parsing of the given media types.

Parameters:
parser - the parser to be decorated
types - supported media types
Returns:
the decorated parser

getSupportedTypes

public java.util.Set<MediaType> getSupportedTypes(ParseContext context)
Delegates the method call to the decorated parser. Subclasses should override this method (and use super.getSupportedTypes() to invoke the decorated parser) to implement extra decoration.

Specified by:
getSupportedTypes in interface Parser
Parameters:
context - parse context
Returns:
immutable set of media types

parse

public void parse(java.io.InputStream stream,
                  org.xml.sax.ContentHandler handler,
                  Metadata metadata,
                  ParseContext context)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  TikaException
Delegates the method call to the decorated parser. Subclasses should override this method (and use super.parse() to invoke the decorated parser) to implement extra decoration.

Specified by:
parse in interface Parser
Parameters:
stream - the document stream (input)
handler - handler for the XHTML SAX events (output)
metadata - document metadata (input and output)
context - parse context
Throws:
java.io.IOException - if the document stream could not be read
org.xml.sax.SAXException - if the SAX events could not be processed
TikaException - if the document could not be parsed

parse

public void parse(java.io.InputStream stream,
                  org.xml.sax.ContentHandler handler,
                  Metadata metadata)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  TikaException
Deprecated. This method will be removed in Apache Tika 1.0.

Description copied from interface: Parser
The parse() method from Tika 0.4 and earlier. Please use the Parser.parse(InputStream, ContentHandler, Metadata, ParseContext) method instead in new code. Calls to this backwards compatibility method are forwarded to the new parse() method with an empty parse context.

Specified by:
parse in interface Parser
Throws:
java.io.IOException
org.xml.sax.SAXException
TikaException

getWrappedParser

public Parser getWrappedParser()
Gets the parser wrapped by this ParserDecorator

Returns:


Copyright © 2007-2011 The Apache Software Foundation. All Rights Reserved.