de.aitools.ie.decomposition.word
Class WordDecompositionOpenNLP

java.lang.Object
  extended by de.aitools.ie.decomposition.word.WordDecompositionOpenNLP
All Implemented Interfaces:
Decomposition

public class WordDecompositionOpenNLP
extends java.lang.Object
implements Decomposition

This class decomposes a given String into words with machine learning technique using openNLP.

Author:
Steffen Becker
See Also:
WordDecompositionICU4J, WordDecompositionDelim

Constructor Summary
WordDecompositionOpenNLP(java.util.Locale locale)
          Initialises a new decomposition depended on the trained language.
WordDecompositionOpenNLP(java.lang.String modelFile)
          Initialises a new decomposition using a maximum entropy model.
 
Method Summary
 java.util.List<Span> getSpans(java.lang.String text)
          Analyses a string and split it in parts.
 java.util.List<java.lang.String> getStrings(java.lang.String text, boolean asSubstring)
          Analyses a string and split it in parts.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WordDecompositionOpenNLP

public WordDecompositionOpenNLP(java.lang.String modelFile)
                         throws java.io.IOException
Initialises a new decomposition using a maximum entropy model.

Parameters:
modelFile - Location of the maximum entropy model.
Throws:
java.io.IOException

WordDecompositionOpenNLP

public WordDecompositionOpenNLP(java.util.Locale locale)
                         throws java.lang.Exception
Initialises a new decomposition depended on the trained language.

Parameters:
locale - for language
Throws:
java.lang.Exception
Method Detail

getSpans

public java.util.List<Span> getSpans(java.lang.String text)
Description copied from interface: Decomposition
Analyses a string and split it in parts. The return value is a list of Spans with start/end index in original string.

Specified by:
getSpans in interface Decomposition
Parameters:
text - The original text to decompose.
Returns:
List of Span with start/end index in the original string.
See Also:
Decomposition#getStrings(String, boolean)}

getStrings

public java.util.List<java.lang.String> getStrings(java.lang.String text,
                                                   boolean asSubstring)
Description copied from interface: Decomposition
Analyses a string and split it in parts. The return value is a list of this parts as Strings, either as substrings or string copies dependent on asSubstring parameter.

Specified by:
getStrings in interface Decomposition
Parameters:
text - The original text to decompose.
asSubstring - If true, returned strings in list are substrings of input text else explicit copies are returned. A substring is a pointer to the original string and start/end position. A string copy is an exact copy of the part.
If you are interested just in some parts of the text and don't want to hold the hole text in main memory, you might choose string copies.
Returns:
List of string, as substrings or string copies dependent on asSubstring parameter.
See Also:
Decomposition#getSpans(String)}