ChunkSampleStream (Apache OpenNLP Tools 2.0.0 API)

java.lang.Object
- opennlp.tools.util.FilterObjectStream<String,ChunkSample>
- - opennlp.tools.chunker.ChunkSampleStream

All Implemented Interfaces:

AutoCloseable, ObjectStream<ChunkSample>
```
public class ChunkSampleStream
extends FilterObjectStream<String,ChunkSample>
```
Parses the conll 2000 shared task shallow parser training data.
Data format is specified on the conll page:
http://www.cnts.ua.ac.be/conll2000/chunking/

- Constructor Summary
  
  Constructors
  Constructor Description
  
  ChunkSampleStream(ObjectStream<String> samples)
  Initializes the current instance.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  ChunkSample read()
  Returns the next 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
  - ChunkSampleStream
```
public ChunkSampleStream(ObjectStream<String> samples)
```
    Initializes the current instance.
    
    Parameters:
    
    samples - a plain text line stream
- Method Detail
  - read
```
public ChunkSample read()
                 throws IOException
```
    Description copied from interface: ObjectStream
    
    Returns the next object. Calling this method repeatedly until it returns null will return each object from the underlying source exactly once.
    
    Returns:
    
    the next object or null to signal that the stream is exhausted
    
    Throws:
    
    IOException - if there is an error during reading