Package opennlp.tools.formats
Class Conll03NameSampleStream
- java.lang.Object
-
- opennlp.tools.formats.Conll03NameSampleStream
-
- All Implemented Interfaces:
AutoCloseable,ObjectStream<NameSample>
public class Conll03NameSampleStream extends Object implements ObjectStream<NameSample>
An import stream which can parse the CONLL03 data.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classConll03NameSampleStream.LANGUAGE
-
Constructor Summary
Constructors Constructor Description Conll03NameSampleStream(Conll03NameSampleStream.LANGUAGE lang, InputStreamFactory in, int types)Initializes aConll03NameSampleStream.Conll03NameSampleStream(Conll03NameSampleStream.LANGUAGE lang, ObjectStream<String> lineStream, int types)Initializes aConll03NameSampleStream.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes theObjectStreamand releases all allocated resources.NameSampleread()Returns the nextObjectStreamobject.voidreset()Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
-
-
-
Constructor Detail
-
Conll03NameSampleStream
public Conll03NameSampleStream(Conll03NameSampleStream.LANGUAGE lang, ObjectStream<String> lineStream, int types)
Initializes aConll03NameSampleStream.- Parameters:
lang- The language of the CONLL 03 data.lineStream- AnObjectStreamover the lines in the CONLL 03 data file.types- The entity types to include in the Name Sample object stream.
-
Conll03NameSampleStream
public Conll03NameSampleStream(Conll03NameSampleStream.LANGUAGE lang, InputStreamFactory in, int types) throws IOException
Initializes aConll03NameSampleStream.- Parameters:
lang- The language of the CONLL 03 data.in- TheInputStreamFactoryfor the input file.types- The entity types to include in the Name Sample object stream.- Throws:
IOException- Thrown if IO errors occurred.
-
-
Method Detail
-
read
public NameSample read() throws IOException
Description copied from interface:ObjectStreamReturns the nextObjectStreamobject. Calling this method repeatedly until it returnsnullwill return each object from the underlying source exactly once.- Specified by:
readin interfaceObjectStream<NameSample>- Returns:
- The next object or
nullto signal that the stream is exhausted. - Throws:
IOException- Thrown if there is an error during reading.
-
reset
public void reset() throws IOException, UnsupportedOperationExceptionDescription copied from interface:ObjectStreamRepositions the stream at the beginning and the previously seen object sequence will be repeated exactly. This method can be used to re-read the stream if multiple passes over the objects are required.The implementation of this method is optional.
- Specified by:
resetin interfaceObjectStream<NameSample>- Throws:
IOException- Thrown if there is an error during resetting the stream.UnsupportedOperationException- Thrown if thereset()is not supported. By default, this is the case.
-
close
public void close() throws IOExceptionDescription copied from interface:ObjectStreamCloses theObjectStreamand releases all allocated resources. After close was called, it's not allowed to callObjectStream.read()orObjectStream.reset().- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceObjectStream<NameSample>- Throws:
IOException- Thrown if there is an error during closing the stream.
-
-