opennlp.tools.namefind
Class NameFinderEventStream

java.lang.Object
  opennlp.model.AbstractEventStream
      opennlp.tools.namefind.NameFinderEventStream

All Implemented Interfaces:

opennlp.model.EventStream

public class NameFinderEventStream
extends opennlp.model.AbstractEventStream

Class for creating an event stream out of data files for training an name finder.

Constructor Summary

NameFinderEventStream(ObjectStream<NameSample> dataStream)

NameFinderEventStream(ObjectStream<NameSample> dataStream, String type, NameContextGenerator contextGenerator)
Creates a new name finder event stream using the specified data stream and context generator.

Method Summary

static String[][]	additionalContext(String[] tokens, Map<String,String> prevMap) Generated previous decision features for each token based on contents of the specified map.
static String[]	generateOutcomes(Span[] names, String type, int length) Generates the name tag outcomes (start, continue, other) for each token in a sentence with the specified length using the specified name spans.
boolean	hasNext()
static void	main(String[] args)
opennlp.model.Event	next()

Methods inherited from class opennlp.model.AbstractEventStream

remove

Methods inherited from class java.lang.Object

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

Constructor Detail

NameFinderEventStream

public NameFinderEventStream(ObjectStream<NameSample> dataStream,
                             String type,
                             NameContextGenerator contextGenerator)

Creates a new name finder event stream using the specified data stream and context generator.

Parameters:

dataStream - The data stream of events.

type - null or overrides the type parameter in the provided samples

contextGenerator - The context generator used to generate features for the event stream.

NameFinderEventStream

public NameFinderEventStream(ObjectStream<NameSample> dataStream)

Method Detail

generateOutcomes

public static String[] generateOutcomes(Span[] names,
                                        String type,
                                        int length)

Generates the name tag outcomes (start, continue, other) for each token in a sentence with the specified length using the specified name spans.

Parameters:

names - Token spans for each of the names.

type - null or overrides the type parameter in the provided samples

length - The length of the sentence.

Returns:

An array of start, continue, other outcomes based on the specified names and sentence length.

hasNext

public boolean hasNext()
                throws IOException

Throws:

IOException

next

public opennlp.model.Event next()

additionalContext

public static String[][] additionalContext(String[] tokens,
                                           Map<String,String> prevMap)

Generated previous decision features for each token based on contents of the specified map.

Parameters:

tokens - The token for which the context is generated.

prevMap - A mapping of tokens to their previous decisions.

Returns:

An additional context array with features for each token.

main

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

Throws:

IOException