org.apache.uima.simpleserver.config
Interface TypeMap

All Known Implementing Classes:

TypeMapImpl

public interface TypeMap

Represents a type map in a service spec.

Method Summary

void	addOutput(Output output) Add an output spec.
Filter	getFilter() Get the filter for this map.
String	getLongDescription()
boolean	getOutputAll() Get the "output all" switch.
List<Output>	getOutputs() Get list of output specs.
String	getOutputTag() Get the output tag that the type name is mapped to.
String	getShortDescription()
String	getTypeName() Get the type name.
boolean	isOutputCoveredText() Get the switch for covered text.

Method Detail

getFilter

Filter getFilter()

Get the filter for this map.

Returns:

This map's filter; may be null.

getOutputAll

boolean getOutputAll()

Get the "output all" switch. If this is set to true, output all simple-valued features of the given type. Defaults to false.

Returns:

The "output all" switch.

getOutputs

List<Output> getOutputs()

Get list of output specs.

Returns:

This map's output specs.

addOutput

void addOutput(Output output)

Add an output spec.

Parameters:

output -

getOutputTag

String getOutputTag()

Get the output tag that the type name is mapped to.

Returns:

This type map's output tag.

getTypeName

String getTypeName()

Get the type name.

Returns:

This map's type name; objects of this type will be considered for output.

isOutputCoveredText

boolean isOutputCoveredText()

Get the switch for covered text.

Returns:

Whether this map outputs the covered text for each annotation.

getShortDescription

String getShortDescription()

Returns:

The short description (one line) of this map; may be null.

getLongDescription

String getLongDescription()

Returns:

The long description of this map; may be null.