Package org.apache.any23.extractor.yaml

Class YAMLExtractor

java.lang.Object

org.apache.any23.extractor.yaml.YAMLExtractor

All Implemented Interfaces:

Extractor<InputStream>, Extractor.ContentExtractor

public class YAMLExtractor
extends Object
implements Extractor.ContentExtractor

Author:

Jacek Grzebyta (grzebyta.dev [at] gmail.com)

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
YAMLExtractor()

Method Summary

Modifier and Type	Method	Description
ExtractorDescription	getDescription()	Returns a ExtractorDescription of this extractor.
void	run(ExtractionParameters extractionParameters, ExtractionContext context, InputStream in, ExtractionResult out)	Executes the extractor.
void	setStopAtFirstError(boolean f)	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

YAMLExtractor

public YAMLExtractor()

Method Detail

setStopAtFirstError

public void setStopAtFirstError(boolean f)

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:

f - tolerance flag.

run

public void run(ExtractionParameters extractionParameters,
                ExtractionContext context,
                InputStream in,
                ExtractionResult out)
         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.

context - The document context.

in - The extractor input data.

out - the collector for the extracted data.

Throws:

IOException - On error while reading from the input stream.

ExtractionException - On other error, such as parse errors.

getDescription

public ExtractorDescription getDescription()

Description copied from interface: Extractor

Returns a ExtractorDescription of this extractor.

Specified by:

getDescription in interface Extractor<InputStream>

Returns:

the object representing the extractor description.