opennlp.tools.namefind
Class NameFinderEventStream

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

All Implemented Interfaces:

opennlp.maxent.EventStream

public class NameFinderEventStream
extends java.lang.Object
implements opennlp.maxent.EventStream

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

Constructor Summary

NameFinderEventStream(NameSampleStream dataStream)

NameFinderEventStream(NameSampleStream dataStream, NameContextGenerator contextGenerator)
Creates a new name finder event stream using the specified data stream and context generator.

Method Summary

static java.lang.String[][]	additionalContext(java.lang.String[] tokens, java.util.Map prevMap) Generated previous decision features for each token based on contents of the specifed map.
static java.lang.String[]	generateOutcomes(Span[] names, java.lang.String[] nameTypes, 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(java.lang.String[] args)
opennlp.maxent.Event	nextEvent()

Methods inherited from class java.lang.Object

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

Constructor Detail

NameFinderEventStream

public NameFinderEventStream(NameSampleStream dataStream,
                             NameContextGenerator contextGenerator)

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

Parameters:

dataStream - The data stream of events.

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

NameFinderEventStream

public NameFinderEventStream(NameSampleStream dataStream)

Method Detail

generateOutcomes

public static java.lang.String[] generateOutcomes(Span[] names,
                                                  java.lang.String[] nameTypes,
                                                  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.

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()

Specified by:

hasNext in interface opennlp.maxent.EventStream

nextEvent

public opennlp.maxent.Event nextEvent()

Specified by:

nextEvent in interface opennlp.maxent.EventStream

additionalContext

public static java.lang.String[][] additionalContext(java.lang.String[] tokens,
                                                     java.util.Map prevMap)

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

Parameters:

tokens - The token for which the context is generated.

prevMap - A mapping of tokens to their previous decisions.

Returns:

An additional context arrary with features for each token.

main

public static final void main(java.lang.String[] args)
                       throws java.io.IOException

Throws:

java.io.IOException