org.apache.tika.sax

Class BasicContentHandlerFactory

java.lang.Object

org.apache.tika.sax.BasicContentHandlerFactory

All Implemented Interfaces:

Serializable, ContentHandlerFactory, WriteLimiter

public class BasicContentHandlerFactory
extends Object
implements ContentHandlerFactory, WriteLimiter

Basic factory for creating common types of ContentHandlers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicContentHandlerFactory.HANDLER_TYPE Common handler types for content.

Constructor Summary

Constructors

Constructor and Description
BasicContentHandlerFactory(BasicContentHandlerFactory.HANDLER_TYPE type, int writeLimit)
BasicContentHandlerFactory(BasicContentHandlerFactory.HANDLER_TYPE type, int writeLimit, boolean throwOnWriteLimitReached, ParseContext parseContext)

Method Summary

Modifier and Type	Method and Description
ContentHandler	getNewContentHandler()
ContentHandler	getNewContentHandler(OutputStream os, Charset charset)
ContentHandler	getNewContentHandler(OutputStream os, String encoding)
BasicContentHandlerFactory.HANDLER_TYPE	getType()
int	getWriteLimit()
boolean	isThrowOnWriteLimitReached()
static BasicContentHandlerFactory.HANDLER_TYPE	parseHandlerType(String handlerTypeName, BasicContentHandlerFactory.HANDLER_TYPE defaultType) Tries to parse string into handler type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicContentHandlerFactory

public BasicContentHandlerFactory(BasicContentHandlerFactory.HANDLER_TYPE type,
                                  int writeLimit)

Parameters:

type - basic type of handler

writeLimit - max number of characters to store; if < 0, the handler will store all characters

BasicContentHandlerFactory

public BasicContentHandlerFactory(BasicContentHandlerFactory.HANDLER_TYPE type,
                                  int writeLimit,
                                  boolean throwOnWriteLimitReached,
                                  ParseContext parseContext)

Parameters:

type - basic type of handler

writeLimit - maximum number of characters to store

throwOnWriteLimitReached - whether or not to throw a WriteLimitReachedException when the write limit has been reached

parseContext - to store the writelimitreached warning if throwOnWriteLimitReached is set to false

Method Detail

parseHandlerType

public static BasicContentHandlerFactory.HANDLER_TYPE parseHandlerType(String handlerTypeName,
                                                                       BasicContentHandlerFactory.HANDLER_TYPE defaultType)

Tries to parse string into handler type. Returns default if string is null or parse fails.

Options: xml, html, text, body, ignore (no content)

Parameters:

handlerTypeName - string to parse

defaultType - type to return if parse fails

Returns:

handler type

getNewContentHandler

public ContentHandler getNewContentHandler()

Specified by:

getNewContentHandler in interface ContentHandlerFactory

getNewContentHandler

public ContentHandler getNewContentHandler(OutputStream os,
                                           String encoding)
                                    throws UnsupportedEncodingException

Specified by:

getNewContentHandler in interface ContentHandlerFactory

Throws:

UnsupportedEncodingException

getNewContentHandler

public ContentHandler getNewContentHandler(OutputStream os,
                                           Charset charset)

Specified by:

getNewContentHandler in interface ContentHandlerFactory

getType

public BasicContentHandlerFactory.HANDLER_TYPE getType()

Returns:

handler type used by this factory

getWriteLimit

public int getWriteLimit()

Specified by:

getWriteLimit in interface WriteLimiter

isThrowOnWriteLimitReached

public boolean isThrowOnWriteLimitReached()

Specified by:

isThrowOnWriteLimitReached in interface WriteLimiter