Package org.apache.any23.extractor.calendar

Class XCalExtractor

java.lang.Object

org.apache.any23.extractor.calendar.XCalExtractor

All Implemented Interfaces:

Extractor<InputStream>, Extractor.ContentExtractor

public class XCalExtractor
extends Object

Author:

Hans Brende (hansbrende@apache.org)

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.any23.extractor.Extractor

Extractor.BlindExtractor, Extractor.ContentExtractor, Extractor.TagSoupDOMExtractor

Constructor Summary

Constructors

Constructor	Description
XCalExtractor()

Method Summary

Modifier and Type	Method	Description
ExtractorDescription	getDescription()	Returns a ExtractorDescription of this extractor.
void	run(ExtractionParameters extractionParameters, ExtractionContext extractionContext, InputStream inputStream, ExtractionResult result)	Executes the extractor.
void	setStopAtFirstError(boolean b)	If true, the extractor will stop at first parsing error, iffalse the extractor will attempt to ignore all parsing errors.

Methods inherited from class java.lang.Object

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

Constructor Detail

XCalExtractor

public XCalExtractor()

Method Detail

getDescription

public ExtractorDescription getDescription()

Description copied from interface: Extractor

Returns a ExtractorDescription of this extractor.

Returns:

the object representing the extractor description.

setStopAtFirstError

public void setStopAtFirstError(boolean b)

Description copied from interface: Extractor.ContentExtractor

If true, the extractor will stop at first parsing error, iffalse the extractor will attempt to ignore all parsing errors.

Specified by:

setStopAtFirstError in interface Extractor.ContentExtractor

Parameters:

b - tolerance flag.

run

public final void run(ExtractionParameters extractionParameters,
                      ExtractionContext extractionContext,
                      InputStream inputStream,
                      ExtractionResult result)
               throws IOException,
                      ExtractionException

Description copied from interface: Extractor

Executes the extractor. Will be invoked only once, extractors are not reusable.

Specified by:

run in interface Extractor<InputStream>

Parameters:

extractionParameters - the parameters to be applied during the extraction.

extractionContext - The document context.

inputStream - The extractor input data.

result - the collector for the extracted data.

Throws:

IOException - On error while reading from the input stream.

ExtractionException - On other error, such as parse errors.