edu.stanford.nlp.ie.regexp

Class ChineseNumberSequenceClassifier

java.lang.Object

edu.stanford.nlp.ie.AbstractSequenceClassifier<CoreLabel>

edu.stanford.nlp.ie.regexp.ChineseNumberSequenceClassifier

All Implemented Interfaces:

java.util.function.Function<java.lang.String,java.lang.String>

public class ChineseNumberSequenceClassifier
extends AbstractSequenceClassifier<CoreLabel>

A simple rule-based classifier that detects NUMBERs in a sequence of Chinese tokens. This classifier mimics the behavior of NumberSequenceClassifier (without using SUTime) and works on Chinese sequence. TODO: An interface needs to be used to reuse code for NumberSequenceClassifier TODO: Ideally a Chinese version of SUTime needs to be used to provide more flexibility and accuracy.

Author:

Yuhao Zhang, Peng Qi

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	CURRENCY_WORD_PATTERN
static java.lang.String[]	CURRENCY_WORDS_VALUES
static java.util.regex.Pattern	DATE_PATTERN1
static java.util.regex.Pattern	DATE_PATTERN2
static java.util.regex.Pattern	DATE_PATTERN3
static java.util.regex.Pattern	DATE_PATTERN4
static java.util.regex.Pattern	DATE_PATTERN5
static java.lang.String	DATE_TAG
static java.util.HashSet<java.lang.String>	DATE_WORDS
static java.lang.String[]	DATE_WORDS_VALUES
static java.lang.String	MONEY_TAG
static java.lang.String	NUMBER_TAG
static java.lang.String	ORDINAL_TAG
static java.lang.String	PERCENT_TAG
static java.util.regex.Pattern	PERCENT_WORD_PATTERN1
static java.util.regex.Pattern	PERCENT_WORD_PATTERN2
static java.lang.String	SUTIME_PROPERTY
static java.util.regex.Pattern	TIME_PATTERN1
static java.lang.String	TIME_TAG
static java.util.HashSet<java.lang.String>	TIME_WORDS
static java.lang.String[]	TIME_WORDS_VALUES
static boolean	USE_SUTIME_DEFAULT
static java.lang.String	USE_SUTIME_PROPERTY
static java.lang.String	USE_SUTIME_PROPERTY_BASE

Fields inherited from class edu.stanford.nlp.ie.AbstractSequenceClassifier

classIndex, featureFactories, flags, knownLCWords, pad, windowSize

Constructor Summary

Constructors

Constructor and Description
ChineseNumberSequenceClassifier()
ChineseNumberSequenceClassifier(boolean useSUTime)
ChineseNumberSequenceClassifier(java.util.Properties props, boolean useSUTime, java.util.Properties sutimeProps)

Method Summary

Modifier and Type	Method and Description
java.util.List<CoreLabel>	classify(java.util.List<CoreLabel> document) Use a set of heuristic rules to assign NER tags to tokens.
java.util.List<CoreLabel>	classifyWithGlobalInformation(java.util.List<CoreLabel> tokenSequence, CoreMap document, CoreMap sentence) Classify a List of something that extends CoreMap using as additional information whatever is stored in the document and sentence.
void	loadClassifier(java.io.ObjectInputStream in, java.util.Properties props) Load a classifier from the specified input stream.
static void	main(java.lang.String[] args)
void	serializeClassifier(java.io.ObjectOutputStream oos) Serialize a sequence classifier to an object output stream
void	serializeClassifier(java.lang.String serializePath) Serialize a sequence classifier to a file on the given path.
void	train(java.util.Collection<java.util.List<CoreLabel>> docs, DocumentReaderAndWriter<CoreLabel> readerAndWriter) Trains a classifier from a Collection of sequences.

Methods inherited from class edu.stanford.nlp.ie.AbstractSequenceClassifier

apply, backgroundSymbol, classify, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswers, classifyAndWriteAnswersKBest, classifyAndWriteAnswersKBest, classifyAndWriteViterbiSearchGraph, classifyFile, classifyFilesAndWriteAnswers, classifyFilesAndWriteAnswers, classifyKBest, classifyRaw, classifySentence, classifySentenceWithGlobalInformation, classifyStdin, classifyStdin, classifyToCharacterOffsets, classifyToString, classifyToString, classifyWithInlineXML, countResults, countResultsSegmenter, defaultReaderAndWriter, dumpFeatures, finalizeClassification, getKnownLCWords, getSampler, getSequenceModel, labels, loadClassifier, loadClassifier, loadClassifier, loadClassifier, loadClassifier, loadClassifier, loadClassifierNoExceptions, loadClassifierNoExceptions, loadClassifierNoExceptions, loadClassifierNoExceptions, loadClassifierNoExceptions, makeObjectBankFromFile, makeObjectBankFromFile, makeObjectBankFromFiles, makeObjectBankFromFiles, makeObjectBankFromFiles, makeObjectBankFromReader, makeObjectBankFromString, makePlainTextReaderAndWriter, makePlainTextReaderAndWriter, makeReaderAndWriter, plainTextReaderAndWriter, printFeatureLists, printFeatures, printProbs, printProbs, printProbsDocument, printProbsDocuments, printResults, reinit, segmentString, segmentString, train, train, train, train, train, train, windowSize, writeAnswers

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

USE_SUTIME_DEFAULT

public static final boolean USE_SUTIME_DEFAULT

See Also:

Constant Field Values

USE_SUTIME_PROPERTY

public static final java.lang.String USE_SUTIME_PROPERTY

See Also:

Constant Field Values

USE_SUTIME_PROPERTY_BASE

public static final java.lang.String USE_SUTIME_PROPERTY_BASE

See Also:

Constant Field Values

SUTIME_PROPERTY

public static final java.lang.String SUTIME_PROPERTY

See Also:

Constant Field Values

NUMBER_TAG

public static final java.lang.String NUMBER_TAG

See Also:

Constant Field Values

DATE_TAG

public static final java.lang.String DATE_TAG

See Also:

Constant Field Values

TIME_TAG

public static final java.lang.String TIME_TAG

See Also:

Constant Field Values

MONEY_TAG

public static final java.lang.String MONEY_TAG

See Also:

Constant Field Values

ORDINAL_TAG

public static final java.lang.String ORDINAL_TAG

See Also:

Constant Field Values

PERCENT_TAG

public static final java.lang.String PERCENT_TAG

See Also:

Constant Field Values

CURRENCY_WORD_PATTERN

public static final java.util.regex.Pattern CURRENCY_WORD_PATTERN

PERCENT_WORD_PATTERN1

public static final java.util.regex.Pattern PERCENT_WORD_PATTERN1

PERCENT_WORD_PATTERN2

public static final java.util.regex.Pattern PERCENT_WORD_PATTERN2

DATE_PATTERN1

public static final java.util.regex.Pattern DATE_PATTERN1

DATE_PATTERN2

public static final java.util.regex.Pattern DATE_PATTERN2

DATE_PATTERN3

public static final java.util.regex.Pattern DATE_PATTERN3

DATE_PATTERN4

public static final java.util.regex.Pattern DATE_PATTERN4

DATE_PATTERN5

public static final java.util.regex.Pattern DATE_PATTERN5

TIME_PATTERN1

public static final java.util.regex.Pattern TIME_PATTERN1

CURRENCY_WORDS_VALUES

public static final java.lang.String[] CURRENCY_WORDS_VALUES

DATE_WORDS_VALUES

public static final java.lang.String[] DATE_WORDS_VALUES

DATE_WORDS

public static final java.util.HashSet<java.lang.String> DATE_WORDS

TIME_WORDS_VALUES

public static final java.lang.String[] TIME_WORDS_VALUES

TIME_WORDS

public static final java.util.HashSet<java.lang.String> TIME_WORDS

Constructor Detail

ChineseNumberSequenceClassifier

public ChineseNumberSequenceClassifier()

ChineseNumberSequenceClassifier

public ChineseNumberSequenceClassifier(boolean useSUTime)

ChineseNumberSequenceClassifier

public ChineseNumberSequenceClassifier(java.util.Properties props,
                                       boolean useSUTime,
                                       java.util.Properties sutimeProps)

Method Detail

classify

public java.util.List<CoreLabel> classify(java.util.List<CoreLabel> document)

Use a set of heuristic rules to assign NER tags to tokens.

Specified by:

classify in class AbstractSequenceClassifier<CoreLabel>

Parameters:

document - A List of something that extends CoreMap.

Returns:

classifyWithGlobalInformation

public java.util.List<CoreLabel> classifyWithGlobalInformation(java.util.List<CoreLabel> tokenSequence,
                                                               CoreMap document,
                                                               CoreMap sentence)

Description copied from class: AbstractSequenceClassifier

Classify a List of something that extends CoreMap using as additional information whatever is stored in the document and sentence. This is needed for SUTime (NumberSequenceClassifier), which requires the document date to resolve relative dates.

Specified by:

classifyWithGlobalInformation in class AbstractSequenceClassifier<CoreLabel>

Parameters:

tokenSequence - A List of something that extends CoreMap

Returns:

Classified version of the input tokenSequence

train

public void train(java.util.Collection<java.util.List<CoreLabel>> docs,
                  DocumentReaderAndWriter<CoreLabel> readerAndWriter)

Description copied from class: AbstractSequenceClassifier

Trains a classifier from a Collection of sequences. Note that the Collection can be (and usually is) an ObjectBank.

Specified by:

train in class AbstractSequenceClassifier<CoreLabel>

Parameters:

docs - An ObjectBank or a collection of sequences of IN

readerAndWriter - A DocumentReaderAndWriter to use when loading test files

serializeClassifier

public void serializeClassifier(java.lang.String serializePath)

Description copied from class: AbstractSequenceClassifier

Serialize a sequence classifier to a file on the given path.

Specified by:

serializeClassifier in class AbstractSequenceClassifier<CoreLabel>

Parameters:

serializePath - The path/filename to write the classifier to.

serializeClassifier

public void serializeClassifier(java.io.ObjectOutputStream oos)

Description copied from class: AbstractSequenceClassifier

Serialize a sequence classifier to an object output stream

Specified by:

serializeClassifier in class AbstractSequenceClassifier<CoreLabel>

loadClassifier

public void loadClassifier(java.io.ObjectInputStream in,
                           java.util.Properties props)
                    throws java.io.IOException,
                           java.lang.ClassCastException,
                           java.lang.ClassNotFoundException

Description copied from class: AbstractSequenceClassifier

Load a classifier from the specified input stream. The classifier is reinitialized from the flags serialized in the classifier.

Specified by:

loadClassifier in class AbstractSequenceClassifier<CoreLabel>

Parameters:

in - The InputStream to load the serialized classifier from

props - This Properties object will be used to update the SeqClassifierFlags which are read from the serialized classifier

Throws:

java.io.IOException - If there are problems accessing the input stream

java.lang.ClassCastException - If there are problems interpreting the serialized data

java.lang.ClassNotFoundException - If there are problems interpreting the serialized data

main

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

Throws:

java.io.IOException