au.org.ala.names.model
Enum MatchType

java.lang.Object
  java.lang.Enum<MatchType>
      au.org.ala.names.model.MatchType

All Implemented Interfaces:

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

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

An enumeration that represents the type of match that has been performed. Some of these match types will only happen within certain search types.

Enum Constant Summary

ALTERNATE
Deprecated. Used in the OLD search API

CANONICAL
The supplied name was parsed into canonical form before a match was obtained.

DIRECT
Deprecated. Used in the OLD search API

EXACT
The supplied name matched the name exactly.

PHRASE
A match was determined by parsing the name into a phrase name.

RECURSIVE
The match is based on the higher level classification Limited to recursive searches ALANameSearcher.searchForRecord(LinnaeanRankClassification, boolean) etc

SEARCHABLE
Deprecated. Usde in the OLD search API

SOUNDEX
A match was determined by using a sound expression of the supplied name.

TAXON_ID
The match was based on the supplied taxon concept ID rather than the scientific name.

VERNACULAR
A match was determined by the vernacular name.

Method Summary

MatchType	getMatchType(java.lang.String match)
java.lang.String	toString()
static MatchType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MatchType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DIRECT

public static final MatchType DIRECT

Deprecated. Used in the OLD search API

EXACT

public static final MatchType EXACT

The supplied name matched the name exactly. Very small chance of an incorrect match.

CANONICAL

public static final MatchType CANONICAL

The supplied name was parsed into canonical form before a match was obtained. There is a chance that the match is incorrect due to parse errors.

PHRASE

public static final MatchType PHRASE

A match was determined by parsing the name into a phrase name. Very small chance of an incorrect match.

SOUNDEX

public static final MatchType SOUNDEX

A match was determined by using a sound expression of the supplied name. There is a greater that average chance that the match is incorrect.

ALTERNATE

public static final MatchType ALTERNATE

Deprecated. Used in the OLD search API

SEARCHABLE

public static final MatchType SEARCHABLE

Deprecated. Usde in the OLD search API

VERNACULAR

public static final MatchType VERNACULAR

A match was determined by the vernacular name. Matches of this type may be unreliable due to the regional/duplicate nature of common names. Limited to searches by common name ALANameSearcher.searchForCommonName(String)

RECURSIVE

public static final MatchType RECURSIVE

The match is based on the higher level classification Limited to recursive searches ALANameSearcher.searchForRecord(LinnaeanRankClassification, boolean) etc

TAXON_ID

public static final MatchType TAXON_ID

The match was based on the supplied taxon concept ID rather than the scientific name. Limited to searches that supplied an id as the search params ALANameSearcher.searchForRecordByLsid(String) etc

Method Detail

values

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<MatchType>

getMatchType

public MatchType getMatchType(java.lang.String match)