cat.lump.ir.retrievalmodels.similarity

Enum Similarity

java.lang.Object

java.lang.Enum<Similarity>

cat.lump.ir.retrievalmodels.similarity.Similarity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Similarity>

public enum Similarity
extends java.lang.Enum<Similarity>

This enumeration contains the similarity models and characterizations available.
Each element has the type of representation of the data that it needs and the similarity model it uses. Both can be null if they are not required.
Moreover, they have a friendly name that can be used to identify them.

Author:

jboldoba

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHAR_N_GRAMS
LENGTH_FACTOR
MONOLINGUAL_BOW
PSEUDOCOGNATES
WIKILINKS

Method Summary

Methods

Modifier and Type	Method and Description
Model	getModel()
java.lang.String	getName()
RepresentationType	getRepresentation()
static Similarity	getSimilarityByName(java.lang.String name)
static Similarity	getSimilarityByRepr(RepresentationType repr) TODO ask Josu about this
static Similarity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Similarity[]	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

CHAR_N_GRAMS

public static final Similarity CHAR_N_GRAMS

LENGTH_FACTOR

public static final Similarity LENGTH_FACTOR

MONOLINGUAL_BOW

public static final Similarity MONOLINGUAL_BOW

PSEUDOCOGNATES

public static final Similarity PSEUDOCOGNATES

WIKILINKS

public static final Similarity WIKILINKS

Method Detail

values

public static Similarity[] 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 (Similarity c : Similarity.values())
    System.out.println(c);

Returns:

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

valueOf

public static Similarity 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

getRepresentation

public RepresentationType getRepresentation()

Returns:

the type of data representation needed by the element

getModel

public Model getModel()

Returns:

the model of similarity used by the element

getName

public java.lang.String getName()

Returns:

the friendly identifier of the element

getSimilarityByName

public static Similarity getSimilarityByName(java.lang.String name)

Parameters:

name - Name which identifies the similarity that we want (cng, cog, len, mono).

Returns:

The similarity entry related to the given name. If no value has this name, is returned.

getSimilarityByRepr

public static Similarity getSimilarityByRepr(RepresentationType repr)

TODO ask Josu about this

Parameters:

name - Name which identifies the similarity that we want (cng, cog, len, mono).

Returns:

The similarity entry related to the given name. If no value has this name, is returned.