Package org.apache.any23.cli

Class ExtractorDocumentation

java.lang.Object

org.apache.any23.cli.ExtractorDocumentation

All Implemented Interfaces:

Tool

public class ExtractorDocumentation
extends Object

This class provides some command-line documentation about available extractors and their usage.

Constructor Summary

Constructors

Constructor	Description
ExtractorDocumentation()

Method Summary

Modifier and Type	Method	Description
void	printError(String msg)	Print an error message.
void	printExampleInput(String extractorName, ExtractorRegistry registry)	Prints an example of input for the provided extractor.
void	printExampleOutput(String extractorName, ExtractorRegistry registry)	Prints an output example for the given extractor.
void	printExtractorList(ExtractorRegistry registry)	Prints the list of all the available extractor names, labels and supported mimetypes.
void	printReport(ExtractorRegistry registry)	Prints a complete report on all the available extractors.
void	run()	Runs the tool and retrieves the exit code.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtractorDocumentation

public ExtractorDocumentation()

Method Detail

run

public void run()
         throws Exception

Description copied from interface: Tool

Runs the tool and retrieves the exit code.

Throws:

Exception - if there is an error running the tool.

printError

public void printError(String msg)

Print an error message.

Parameters:

msg - the error message to be printed

printExtractorList

public void printExtractorList(ExtractorRegistry registry)

Prints the list of all the available extractor names, labels and supported mimetypes.

Parameters:

registry - the ExtractorRegistry containing all extractors

printExampleInput

public void printExampleInput(String extractorName,
                              ExtractorRegistry registry)
                       throws IOException

Prints an example of input for the provided extractor.

Parameters:

extractorName - the name of the extractor

registry - the ExtractorRegistry containing all extractors

Throws:

IOException - raised if no extractor is found with that name

printExampleOutput

public void printExampleOutput(String extractorName,
                               ExtractorRegistry registry)
                        throws IOException,
                               ExtractionException

Prints an output example for the given extractor.

Parameters:

extractorName - the extractor name

registry - the ExtractorRegistry containing all extractors

Throws:

IOException - raised if no extractor is found with that name

ExtractionException - if there is an error duing extraction

printReport

public void printReport(ExtractorRegistry registry)
                 throws IOException,
                        ExtractionException

Prints a complete report on all the available extractors.

Parameters:

registry - the ExtractorRegistry containing all extractors

Throws:

IOException - raised if no extractor is found with that name

ExtractionException - if there is an error duing extraction