WordTagSampleStream (Apache OpenNLP Tools 2.2.0 API)

java.lang.Object
- opennlp.tools.util.FilterObjectStream<String,POSSample>
- - opennlp.tools.postag.WordTagSampleStream

All Implemented Interfaces:

AutoCloseable, ObjectStream<POSSample>
```
public class WordTagSampleStream
extends FilterObjectStream<String,POSSample>
```
A stream filter which reads a sentence per line which contains words and tags in word_tag format and outputs a POSSample objects.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  WordTagSampleStream(ObjectStream<String> sentences)
  Initializes a POSSample instance.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  POSSample read()
  Parses the next sentence and return the next POSSample object.
  - Methods inherited from class opennlp.tools.util.FilterObjectStream
    close, reset
  - Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WordTagSampleStream
```
public WordTagSampleStream(ObjectStream<String> sentences)
```
    Initializes a POSSample instance.
    
    Parameters:
    
    sentences - The sentences to wrap.
- Method Detail
  - read
```
public POSSample read()
               throws IOException
```
    Parses the next sentence and return the next POSSample object.
    If an error occurs an empty POSSample object is returned and a warning message is logged. Usually it does not matter if one or many sentences are ignored.
    
    Returns:
    
    A valid POSSample or null if the sentence stream is exhausted.
    
    Throws:
    
    IOException - Thrown if IO errors occurred during read.