opennlp.tools.postag
Class POSDictionary

java.lang.Object
  opennlp.tools.postag.POSDictionary

All Implemented Interfaces:

Iterable<String>, TagDictionary

public class POSDictionary
extends Object
implements Iterable<String>, TagDictionary

Provides a means of determining which tags are valid for a particular word based on a tag dictionary read from a file.

Author:

Tom Morton

Constructor Summary

POSDictionary()

POSDictionary(BufferedReader reader, boolean caseSensitive)
Deprecated. Use create(InputStream) instead, old format might removed.

POSDictionary(String file)
Deprecated. Use create(InputStream) instead, old format might removed.

POSDictionary(String file, boolean caseSensitive)
Deprecated. Use create(InputStream) instead, old format might removed.

POSDictionary(String file, String encoding, boolean caseSensitive)
Deprecated. Use create(InputStream) instead, old format might removed.

Method Summary

static POSDictionary	create(InputStream in) Creates a new POSDictionary from a provided InputStream.
boolean	equals(Object o)
String[]	getTags(String word) Returns a list of valid tags for the specified word.
Iterator<String>	iterator()
static void	main(String[] args)
void	serialize(OutputStream out) Writes the POSDictionary to the given OutputStream; After the serialization is finished the provided OutputStream remains open.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

POSDictionary

public POSDictionary()

POSDictionary

@Deprecated
public POSDictionary(String file)
              throws IOException

Deprecated. Use create(InputStream) instead, old format might removed.

Creates a tag dictionary with contents of specified file.

Parameters:

file - The file name for the tag dictionary.

Throws:

IOException - when the specified file can not be read.

POSDictionary

@Deprecated
public POSDictionary(String file,
                                boolean caseSensitive)
              throws IOException

Deprecated. Use create(InputStream) instead, old format might removed.

Creates a tag dictionary with contents of specified file and using specified case to determine how to access entries in the tag dictionary.

Parameters:

file - The file name for the tag dictionary.

caseSensitive - Specifies whether the tag dictionary is case sensitive or not.

Throws:

IOException - when the specified file can not be read.

POSDictionary

@Deprecated
public POSDictionary(String file,
                                String encoding,
                                boolean caseSensitive)
              throws IOException

Deprecated. Use create(InputStream) instead, old format might removed.

Creates a tag dictionary with contents of specified file and using specified case to determine how to access entries in the tag dictionary.

Parameters:

file - The file name for the tag dictionary.

encoding - The encoding of the tag dictionary file.

caseSensitive - Specifies whether the tag dictionary is case sensitive or not.

Throws:

IOException - when the specified file can not be read.

POSDictionary

@Deprecated
public POSDictionary(BufferedReader reader,
                                boolean caseSensitive)
              throws IOException

Deprecated. Use create(InputStream) instead, old format might removed.

Create tag dictionary object with contents of specified file and using specified case to determine how to access entries in the tag dictionary.

Parameters:

reader - A reader for the tag dictionary.

caseSensitive - Specifies whether the tag dictionary is case sensitive or not.

Throws:

IOException - when the specified file can not be read.

Method Detail

getTags

public String[] getTags(String word)

Returns a list of valid tags for the specified word.

Specified by:

getTags in interface TagDictionary

Parameters:

word - The word.

Returns:

A list of valid tags for the specified word or null if no information is available for that word.

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

serialize

public void serialize(OutputStream out)
               throws IOException

Writes the POSDictionary to the given OutputStream; After the serialization is finished the provided OutputStream remains open.

Parameters:

out - the OutputStream to write the dictionary into.

Throws:

IOException - if writing to the OutputStream fails

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

create

public static POSDictionary create(InputStream in)
                            throws IOException,
                                   InvalidFormatException

Creates a new POSDictionary from a provided InputStream. After creation is finished the provided InputStream is closed.

Parameters:

in -

Returns:

Throws:

IOException

InvalidFormatException

main

public static void main(String[] args)
                 throws IOException,
                        InvalidFormatException

Throws:

IOException

InvalidFormatException