com.logicaldoc.core.parser

Class AbstractParser

java.lang.Object

com.logicaldoc.core.parser.AbstractParser

All Implemented Interfaces:

Parser

Direct Known Subclasses:

AbiWordParser, DummyParser, HTMLParser, KOfficeParser, OpenOfficeParser, PDFParser, PPTParser, PSParser, RTFParser, TXTParser, WordPerfectParser, XLSParser, XMLParser, ZABWParser

public abstract class AbstractParser
extends Object
implements Parser

Abstract implementation of a Parser

Since:

3.5

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields

Modifier and Type	Field and Description
protected StringBuffer	content
protected String	encoding
protected String	filename
protected Locale	locale
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
AbstractParser()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthor()
String	getContent()
String	getEncoding() The character encoding of the content to be parsed
String	getFilename() The original file name of the content to be parsed
Locale	getLocale() The locale of the content to be parsed
String	getSourceDate()
String	getTags()
String	getTitle()
String	getVersion()
protected abstract void	internalParse(InputStream is) Invoked by the parse method
void	parse(File file) Same as the other method that accept an input stream, use this when you have a file rather than a stream.
void	parse(InputStream input) Extracts content for the text content of the given binary document.
void	setEncoding(String encoding)
void	setFilename(String filename)
void	setLocale(Locale locale)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

content

protected StringBuffer content

filename

protected String filename

locale

protected Locale locale

encoding

protected String encoding

Constructor Detail

AbstractParser

public AbstractParser()

Method Detail

getAuthor

public String getAuthor()

Specified by:

getAuthor in interface Parser

getContent

public String getContent()

Specified by:

getContent in interface Parser

getTags

public String getTags()

Specified by:

getTags in interface Parser

getSourceDate

public String getSourceDate()

Specified by:

getSourceDate in interface Parser

getTitle

public String getTitle()

Specified by:

getTitle in interface Parser

getVersion

public String getVersion()

Specified by:

getVersion in interface Parser

getFilename

public String getFilename()

Description copied from interface: Parser

The original file name of the content to be parsed

Specified by:

getFilename in interface Parser

setFilename

public void setFilename(String filename)

Specified by:

setFilename in interface Parser

getLocale

public Locale getLocale()

Description copied from interface: Parser

The locale of the content to be parsed

Specified by:

getLocale in interface Parser

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface Parser

getEncoding

public String getEncoding()

Description copied from interface: Parser

The character encoding of the content to be parsed

Specified by:

getEncoding in interface Parser

setEncoding

public void setEncoding(String encoding)

Specified by:

setEncoding in interface Parser

parse

public void parse(File file)

Description copied from interface: Parser

Same as the other method that accept an input stream, use this when you have a file rather than a stream.

Specified by:

parse in interface Parser

parse

public void parse(InputStream input)

Description copied from interface: Parser

Extracts content for the text content of the given binary document. The content type and character encoding (if available and applicable) are given as arguments. The given content type is guaranteed to be one of the types reported by #getContentTypes() unless the implementation explicitly permits other content types.

The implementation can choose either to read and parse the given document immediately or to return a reader that does it incrementally. The only constraint is that the implementation must close the given stream latest when the returned reader is closed. The caller on the other hand is responsible for closing the returned reader.

The implementation should only throw an exception on transient errors, i.e. when it can expect to be able to successfully extract the text content of the same binary at another time. An effort should be made to recover from syntax errors and other similar problems.

This method should be thread-safe, i.e. it is possible that this method is invoked simultaneously by different threads to extract the text content of different documents. On the other hand the returned reader does not need to be thread-safe.

The parsing has to be completed before the seconds specified in the parser.timeout config. property.

Specified by:

parse in interface Parser

Parameters:

input - binary document from which to extract text

internalParse

protected abstract void internalParse(InputStream is)
                               throws Exception

Invoked by the parse method

Throws:

Exception