org.apache.ctakes.core.ae

Class SHARPKnowtatorXMLReader

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.JCasAnnotator_ImplBase

org.apache.uima.fit.component.JCasAnnotator_ImplBase

org.apache.ctakes.core.ae.SHARPKnowtatorXMLReader

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

Direct Known Subclasses:

THYMEKnowtatorXMLReader

@PipeBitInfo(name="Knowtator XML Reader (SHARP)",
             description="Reads annotations from SHARP schema Knowtator XML files in a directory.",
             role=SPECIAL,
             products={IDENTIFIED_ANNOTATION,EVENT,TIMEX,LOCATION_RELATION,DEGREE_RELATION,TEMPORAL_RELATION})
public class SHARPKnowtatorXMLReader
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_SET_DEFAULTS
static String	PARAM_TEXT_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
SHARPKnowtatorXMLReader()

Method Summary

Modifier and Type	Method and Description
protected String[]	getAnnotatorNames() Returns the names of the annotators in the Knowtator files that represent the gold standard
protected URI	getKnowtatorURI(org.apache.uima.jcas.JCas jCas) Get the URI for the Knowtator XML file that should be loaded
protected URI	getTextURI(org.apache.uima.jcas.JCas jCas) Get the URI that the text in this class was loaded from
static void	main(String[] args) This main method is only for testing purposes.
void	process(org.apache.uima.jcas.JCas jCas)

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase

getLogger, initialize

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

batchProcessComplete, collectionProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_TEXT_DIRECTORY

public static final String PARAM_TEXT_DIRECTORY

See Also:

Constant Field Values

PARAM_SET_DEFAULTS

public static final String PARAM_SET_DEFAULTS

See Also:

Constant Field Values

Constructor Detail

SHARPKnowtatorXMLReader

public SHARPKnowtatorXMLReader()

Method Detail

getTextURI

protected URI getTextURI(org.apache.uima.jcas.JCas jCas)

Get the URI that the text in this class was loaded from

getKnowtatorURI

protected URI getKnowtatorURI(org.apache.uima.jcas.JCas jCas)

Get the URI for the Knowtator XML file that should be loaded

Throws:

URISyntaxException

getAnnotatorNames

protected String[] getAnnotatorNames()

Returns the names of the annotators in the Knowtator files that represent the gold standard

process

public void process(org.apache.uima.jcas.JCas jCas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

main

public static void main(String[] args)
                 throws Exception

This main method is only for testing purposes. It runs the reader on Knowtator directories. Expects directory named "Knowtator" and a sibling directory "Knowtator_XML". "Knowtator" should have a subdirectory called "text" containing plaintext files "Knowtator_XML" should have files that end with .knowtator.xml

Throws:

Exception

See Also:

getKnowtatorURI(org.apache.uima.jcas.JCas)