org.apache.ctakes.preprocessor

Class DocumentMetaData

java.lang.Object

org.apache.ctakes.preprocessor.DocumentMetaData

public class DocumentMetaData
extends Object

Author:

Mayo Clinic

Constructor Summary

Constructors

Constructor and Description
DocumentMetaData()

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(Annotation a) Adds a single annotation to the syntactic cue annotation list.
void	addAnnotations(List aList) Adds a list of annotations to the syntactic cue annotation list.
void	addMetaData(Object key, Object value) Adds a meta data entry for the document.
void	addSegment(SegmentMetaData smd) Adds a segment.
List	getAnnotations() Gets a list of Annotation objects that represent annotations based off of document syntactic cues.
Map	getMetaData() Gets a map of meta data about the document.
SegmentMetaData	getSegment(String segmentID) Gets meta data about the specified segment.
Set<String>	getSegmentIdentifiers() Gets a set of segment identifiers.
String	getText()
void	setText(String string)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentMetaData

public DocumentMetaData()

Method Detail

addMetaData

public void addMetaData(Object key,
                        Object value)

Adds a meta data entry for the document.

Parameters:

key -

value -

getMetaData

public Map getMetaData()

Gets a map of meta data about the document.

Returns:

addSegment

public void addSegment(SegmentMetaData smd)

Adds a segment.

Parameters:

smd -

getSegmentIdentifiers

public Set<String> getSegmentIdentifiers()

Gets a set of segment identifiers. Each identifier is a String object.

Returns:

Set of String objects, each String is a segment identifier.

getSegment

public SegmentMetaData getSegment(String segmentID)

Gets meta data about the specified segment.

Parameters:

segmentID - Identifier of segment.

Returns:

SegmentMetaData object that contains meta data about the specified segment.

addAnnotation

public void addAnnotation(Annotation a)

Adds a single annotation to the syntactic cue annotation list.

Parameters:

a -

addAnnotations

public void addAnnotations(List aList)

Adds a list of annotations to the syntactic cue annotation list.

Parameters:

aList -

getAnnotations

public List getAnnotations()

Gets a list of Annotation objects that represent annotations based off of document syntactic cues.

Returns:

List of Annotation objects.

getText

public String getText()

Returns:

setText

public void setText(String string)

Parameters:

string -