water.util.comparison.string

Enum QGramComparator.Tokenizer

java.lang.Object

java.lang.Enum<QGramComparator.Tokenizer>

water.util.comparison.string.QGramComparator.Tokenizer

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<QGramComparator.Tokenizer>

Enclosing class:

QGramComparator

public static enum QGramComparator.Tokenizer
extends java.lang.Enum<QGramComparator.Tokenizer>

Represents the different ways we can tokenize a string into a set of q-grams for a given q.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASIC Produces basic q-grams, so that 'gail' -> 'ga', 'ai', 'il'.
ENDS Produces q-grams with padding, so that 'gail' -> '.g', 'ga', 'ai', 'il', 'l.'.
POSITIONAL Produces positional q-grams, so that 'gail' -> 'ga1', 'ai2', 'il3'.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	qgrams(java.lang.String s, int q)
static QGramComparator.Tokenizer	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static QGramComparator.Tokenizer[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BASIC

public static final QGramComparator.Tokenizer BASIC

Produces basic q-grams, so that 'gail' -> 'ga', 'ai', 'il'.

POSITIONAL

public static final QGramComparator.Tokenizer POSITIONAL

Produces positional q-grams, so that 'gail' -> 'ga1', 'ai2', 'il3'.

ENDS

public static final QGramComparator.Tokenizer ENDS

Produces q-grams with padding, so that 'gail' -> '.g', 'ga', 'ai', 'il', 'l.'.

Method Detail

values

public static QGramComparator.Tokenizer[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QGramComparator.Tokenizer c : QGramComparator.Tokenizer.values())
    System.out.println(c);

Returns:

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

valueOf

public static QGramComparator.Tokenizer valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

qgrams

public java.util.Set<java.lang.String> qgrams(java.lang.String s,
                                              int q)