org.annolab.tt4j

Class Util

java.lang.Object

org.annolab.tt4j.Util

public final class Util
extends java.lang.Object

Utility functions.

Author:

Richard Eckart de Castilho

Method Summary

Modifier and Type	Method and Description
static void	close(java.io.Closeable aClosable) Close the given Closeable.
static java.util.List<java.lang.String>	getSearchPaths(java.util.List<java.lang.String> aAdditionalPaths, java.lang.String aSubPath) Get the search paths for a model or executable.
static java.lang.String	join(java.util.Collection<java.lang.String> aStrings, java.lang.String aSeparator) Join the given strings into a single string separated by the given separator.
static java.lang.String	join(java.lang.String[] aStrings, java.lang.String aSeparator) Join the given strings into a single string separated by the given separator.
static boolean	matches(java.lang.String tokenSent, java.lang.String tokenReturned) Checks if a token returned by TreeTagger corresponds to the token sent to TreeTagger.
protected static java.lang.String	readFile(java.io.File aFile, java.lang.String aEncoding) For tests only.
protected static java.lang.String[]	tokenize(java.lang.String aText, java.util.Locale aLocale) For tests only.
protected static void	writeFile(java.lang.String aText, java.io.File aFile, java.lang.String aEncoding) For tests only.

Methods inherited from class java.lang.Object

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

Method Detail

getSearchPaths

public static java.util.List<java.lang.String> getSearchPaths(java.util.List<java.lang.String> aAdditionalPaths,
                                                              java.lang.String aSubPath)

Get the search paths for a model or executable. Using the aSubPath argument, executables and models can be searched for in different locations, e.g. executables in executable and models in models.

The returned list contains the additional search paths, the value of the system property treetagger.home and the environment variables TREETAGGER_HOME and TAGDIR in this order.

Parameters:

aAdditionalPaths - additional paths to search in.

aSubPath - search in the given sub-directory of the search paths.

Returns:

a list of search paths.

join

public static java.lang.String join(java.lang.String[] aStrings,
                                    java.lang.String aSeparator)

Join the given strings into a single string separated by the given separator.

Parameters:

aStrings - strings to join.

aSeparator - a separator.

Returns:

the joined string.

join

public static java.lang.String join(java.util.Collection<java.lang.String> aStrings,
                                    java.lang.String aSeparator)

Join the given strings into a single string separated by the given separator.

Parameters:

aStrings - strings to join.

aSeparator - a separator.

Returns:

the joined string.

matches

public static boolean matches(java.lang.String tokenSent,
                              java.lang.String tokenReturned)

Checks if a token returned by TreeTagger corresponds to the token sent to TreeTagger. This method does not check for strict equality, because if TreeTagger does not know a character, it will return "?" instead. So this method interprets an "?" returned by TreeTagger as a single-character wildcard.

Parameters:

tokenSent - token sent to TreeTagger

tokenReturned - token returned from TreeTagger

Returns:

if the token returned matches the token sent.

close

public static void close(java.io.Closeable aClosable)

Close the given Closeable.

Parameters:

aClosable - a closable object.

readFile

protected static java.lang.String readFile(java.io.File aFile,
                                           java.lang.String aEncoding)
                                    throws java.io.IOException

For tests only.

Parameters:

aFile - the file.

aEncoding - the encoding.

Returns:

the file content.

Throws:

java.io.IOException - if an I/O error occurs.

writeFile

protected static void writeFile(java.lang.String aText,
                                java.io.File aFile,
                                java.lang.String aEncoding)
                         throws java.io.IOException

For tests only.

Parameters:

aText - the text to write.

aFile - the file to write to.

aEncoding - the encoding to use.

Throws:

java.io.IOException - if an I/O error occurs.

tokenize

protected static java.lang.String[] tokenize(java.lang.String aText,
                                             java.util.Locale aLocale)

For tests only.

Parameters:

aText - the text to write.

aLocale - the locale to use for tokenization.

Returns:

the tokens.