org.apache.any23.extractor
Class ExampleInputOutput

java.lang.Object
  extended by org.apache.any23.extractor.ExampleInputOutput

public class ExampleInputOutput
extends Object

A reporter for example input and output of an extractor. Example input is part of every extractor's metadata; example output is obtained by running the extractor on its own example input. This is useful as a documentation device.

Author:
Richard Cyganiak (richard@cyganiak.de)

Constructor Summary
ExampleInputOutput(ExtractorFactory<?> factory)
           
ExampleInputOutput(String extractorName)
           
 
Method Summary
 String getExampleInput()
           
 String getExampleOutput()
           
 String getExampleURI()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExampleInputOutput

public ExampleInputOutput(String extractorName)

ExampleInputOutput

public ExampleInputOutput(ExtractorFactory<?> factory)
Method Detail

getExampleInput

public String getExampleInput()
                       throws IOException
Throws:
IOException

getExampleURI

public String getExampleURI()

getExampleOutput

public String getExampleOutput()
                        throws IOException,
                               ExtractionException
Throws:
IOException
ExtractionException


Copyright © 2010-2012 The Apache Software Foundation. All Rights Reserved.