org.annolab.tt4j
Interface Model

All Known Implementing Classes:

DefaultModel

public interface Model

A TreeTagger model.

Author:

Richard Eckart de Castilho

Method Summary

void	destroy() Destroy transient resources for the model.
java.lang.String	getEncoding() Get the model encoding.
java.io.File	getFile() Get the location of the model.
java.lang.String	getFlushSequence() The the token sequence used to flush the TreeTagger state for the given model.
java.lang.String	getName() Get the name of the model.
void	install() Install the model to the file system (if necessary).

Method Detail

getName

java.lang.String getName()

Get the name of the model.

Returns:

the model name.

install

void install()
             throws java.io.IOException

Install the model to the file system (if necessary).

Throws:

java.io.IOException - if the model cannot be installed.

getFile

java.io.File getFile()

Get the location of the model. Unless install() is called before, the model may not actually be present at this location.

Returns:

the model location.

getEncoding

java.lang.String getEncoding()

Get the model encoding.

Returns:

the model encoding.

getFlushSequence

java.lang.String getFlushSequence()

The the token sequence used to flush the TreeTagger state for the given model. Usually this is a short full sentence in the language the model is trained on. The returned string needs to contain each token separated by a space including a full stop, e.g. "This is a sentence .".

Returns:

the flush sequence.

destroy

void destroy()

Destroy transient resources for the model. E.g. if the model was extracted to a temporary location from an archive/classpath, it can be deleted by this method.