Package org.tribuo.util.tokens.impl

Enum Class SplitFunctionTokenizer.SplitResult

java.lang.Object

java.lang.Enum<SplitFunctionTokenizer.SplitResult>

org.tribuo.util.tokens.impl.SplitFunctionTokenizer.SplitResult

All Implemented Interfaces:

Serializable, Comparable<SplitFunctionTokenizer.SplitResult>, Constable

Enclosing class:

SplitFunctionTokenizer

public static enum SplitFunctionTokenizer.SplitResult
extends Enum<SplitFunctionTokenizer.SplitResult>

A combination of a SplitFunctionTokenizer.SplitType and a Token.TokenType. The TokenType of some SplitResult values are ignored and so not every combination of SplitType and TokenType is provided. For example, SplitFunctionTokenizer.SplitType.SPLIT_AT and SplitFunctionTokenizer.SplitType.SPLIT_BEFORE (as described above) create tokens whose types have already been determined.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_SPLIT_INFIX	Not a split, is infix.
NO_SPLIT_NGRAM	Not a split, is a ngram.
NO_SPLIT_PREFIX	Not a split, is a prefix.
NO_SPLIT_PUNCTUATION	Not a split, is punctuation.
NO_SPLIT_SUFFIX	Not a split, is a suffix.
NO_SPLIT_UNKNOWN	Not a split, is unknown.
NO_SPLIT_WHITESPACE	Not a split, is whitespace.
NO_SPLIT_WORD	Not a split, is a word.
SPLIT_AFTER_INFIX	Split after infix.
SPLIT_AFTER_NGRAM	Split after a ngram.
SPLIT_AFTER_PREFIX	Split after a prefix.
SPLIT_AFTER_PUNCTUATION	Split after punctuation.
SPLIT_AFTER_SUFFIX	Split after a suffix.
SPLIT_AFTER_UNKNOWN	Split after an unknown value.
SPLIT_AFTER_WHITESPACE	Split after whitespace.
SPLIT_AFTER_WORD	Split after a word.
SPLIT_AT	Split at.
SPLIT_BEFORE	Split before.
SPLIT_BEFORE_AND_AFTER_INFIX	Split before and after infix.
SPLIT_BEFORE_AND_AFTER_NGRAM	Split before and after a ngram.
SPLIT_BEFORE_AND_AFTER_PREFIX	Split before and after prefix.
SPLIT_BEFORE_AND_AFTER_PUNCTUATION	Split before and after punctuation.
SPLIT_BEFORE_AND_AFTER_SUFFIX	Split before and after suffix.
SPLIT_BEFORE_AND_AFTER_UNKNOWN	Split before and after unknown.
SPLIT_BEFORE_AND_AFTER_WHITESPACE	Split before and after whitespace.
SPLIT_BEFORE_AND_AFTER_WORD	Split before and after a word.

Field Summary

Fields

Modifier and Type	Field	Description
final SplitFunctionTokenizer.SplitType	splitType	The split type.
final Token.TokenType	tokenType	The token type.

Method Summary

Modifier and Type	Method	Description
static SplitFunctionTokenizer.SplitResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SplitFunctionTokenizer.SplitResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_SPLIT_WORD

public static final SplitFunctionTokenizer.SplitResult NO_SPLIT_WORD

Not a split, is a word.

NO_SPLIT_NGRAM

public static final SplitFunctionTokenizer.SplitResult NO_SPLIT_NGRAM

Not a split, is a ngram.

NO_SPLIT_PUNCTUATION

public static final SplitFunctionTokenizer.SplitResult NO_SPLIT_PUNCTUATION

Not a split, is punctuation.

NO_SPLIT_WHITESPACE

public static final SplitFunctionTokenizer.SplitResult NO_SPLIT_WHITESPACE

Not a split, is whitespace.

NO_SPLIT_PREFIX

public static final SplitFunctionTokenizer.SplitResult NO_SPLIT_PREFIX

Not a split, is a prefix.

NO_SPLIT_SUFFIX

public static final SplitFunctionTokenizer.SplitResult NO_SPLIT_SUFFIX

Not a split, is a suffix.

NO_SPLIT_INFIX

public static final SplitFunctionTokenizer.SplitResult NO_SPLIT_INFIX

Not a split, is infix.

NO_SPLIT_UNKNOWN

public static final SplitFunctionTokenizer.SplitResult NO_SPLIT_UNKNOWN

Not a split, is unknown.

SPLIT_AT

public static final SplitFunctionTokenizer.SplitResult SPLIT_AT

Split at.

SPLIT_BEFORE

public static final SplitFunctionTokenizer.SplitResult SPLIT_BEFORE

Split before.

SPLIT_AFTER_WORD

public static final SplitFunctionTokenizer.SplitResult SPLIT_AFTER_WORD

Split after a word.

SPLIT_AFTER_NGRAM

public static final SplitFunctionTokenizer.SplitResult SPLIT_AFTER_NGRAM

Split after a ngram.

SPLIT_AFTER_PUNCTUATION

public static final SplitFunctionTokenizer.SplitResult SPLIT_AFTER_PUNCTUATION

Split after punctuation.

SPLIT_AFTER_WHITESPACE

public static final SplitFunctionTokenizer.SplitResult SPLIT_AFTER_WHITESPACE

Split after whitespace.

SPLIT_AFTER_PREFIX

public static final SplitFunctionTokenizer.SplitResult SPLIT_AFTER_PREFIX

Split after a prefix.

SPLIT_AFTER_SUFFIX

public static final SplitFunctionTokenizer.SplitResult SPLIT_AFTER_SUFFIX

Split after a suffix.

SPLIT_AFTER_INFIX

public static final SplitFunctionTokenizer.SplitResult SPLIT_AFTER_INFIX

Split after infix.

SPLIT_AFTER_UNKNOWN

public static final SplitFunctionTokenizer.SplitResult SPLIT_AFTER_UNKNOWN

Split after an unknown value.

SPLIT_BEFORE_AND_AFTER_WORD

public static final SplitFunctionTokenizer.SplitResult SPLIT_BEFORE_AND_AFTER_WORD

Split before and after a word.

SPLIT_BEFORE_AND_AFTER_NGRAM

public static final SplitFunctionTokenizer.SplitResult SPLIT_BEFORE_AND_AFTER_NGRAM

Split before and after a ngram.

SPLIT_BEFORE_AND_AFTER_PUNCTUATION

public static final SplitFunctionTokenizer.SplitResult SPLIT_BEFORE_AND_AFTER_PUNCTUATION

Split before and after punctuation.

SPLIT_BEFORE_AND_AFTER_WHITESPACE

public static final SplitFunctionTokenizer.SplitResult SPLIT_BEFORE_AND_AFTER_WHITESPACE

Split before and after whitespace.

SPLIT_BEFORE_AND_AFTER_PREFIX

public static final SplitFunctionTokenizer.SplitResult SPLIT_BEFORE_AND_AFTER_PREFIX

Split before and after prefix.

SPLIT_BEFORE_AND_AFTER_SUFFIX

public static final SplitFunctionTokenizer.SplitResult SPLIT_BEFORE_AND_AFTER_SUFFIX

Split before and after suffix.

SPLIT_BEFORE_AND_AFTER_INFIX

public static final SplitFunctionTokenizer.SplitResult SPLIT_BEFORE_AND_AFTER_INFIX

Split before and after infix.

SPLIT_BEFORE_AND_AFTER_UNKNOWN

public static final SplitFunctionTokenizer.SplitResult SPLIT_BEFORE_AND_AFTER_UNKNOWN

Split before and after unknown.

Field Details

splitType

public final SplitFunctionTokenizer.SplitType splitType

The split type.

tokenType

public final Token.TokenType tokenType

The token type.

Method Details

values

public static SplitFunctionTokenizer.SplitResult[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SplitFunctionTokenizer.SplitResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null