au.org.ala.names.model
Enum RankType

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

All Implemented Interfaces:

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

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

An enumeration of the rank types available in ALA, with some text vocabulary that can be used to match to a RankType.

This is based on org.ala.web.util.RankFacet

Author:

Natasha

Enum Constant Summary

CLASS

CULTIVAR

CULTIVARGROUP

FAMILY

FORM

GENUS

HYBRID

INFORMAL

INFRACLASS

INFRAGENERICNNAME

INFRAORDER

INFRASPECIFICNAME

INFRASUBSPECIESNAME

KINGDOM

ORDER

PHYLUM

SECTION

SERIES

SPECIES

SUBCLASS

SUBFAMILY

SUBFORM

SUBGENUS

SUBKINGDOM

SUBORDER

SUBPHYLUM

SUBSECTION

SUBSERIES

SUBSPECIES

SUBTRIBE

SUBVARIETY

SUPERCLASS

SUPERFAMILY

SUPERORDER

SUPRAGENERICNAME

TRIBE

UNRANKED

VARIETY

Method Summary

static java.util.Set<RankType>	getAllRanksBelow(java.lang.Integer rank)
java.lang.Float	getBoost()
static RankType	getForCBRank(org.gbif.ecat.voc.Rank cbRank)
static RankType	getForId(java.lang.Integer id)
static RankType	getForName(java.lang.String field)
static RankType	getForStrRank(java.lang.String rank) Gets the Rank Type for the supplied raw string...
java.lang.Integer	getId()
java.lang.String	getRank()
static RankType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RankType[]	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

KINGDOM

public static final RankType KINGDOM

SUBKINGDOM

public static final RankType SUBKINGDOM

PHYLUM

public static final RankType PHYLUM

SUBPHYLUM

public static final RankType SUBPHYLUM

SUPERCLASS

public static final RankType SUPERCLASS

CLASS

public static final RankType CLASS

INFRACLASS

public static final RankType INFRACLASS

SUBCLASS

public static final RankType SUBCLASS

SUPERORDER

public static final RankType SUPERORDER

ORDER

public static final RankType ORDER

SUBORDER

public static final RankType SUBORDER

INFRAORDER

public static final RankType INFRAORDER

SUPERFAMILY

public static final RankType SUPERFAMILY

FAMILY

public static final RankType FAMILY

SUBFAMILY

public static final RankType SUBFAMILY

TRIBE

public static final RankType TRIBE

SUBTRIBE

public static final RankType SUBTRIBE

GENUS

public static final RankType GENUS

SUBGENUS

public static final RankType SUBGENUS

SECTION

public static final RankType SECTION

SUBSECTION

public static final RankType SUBSECTION

SERIES

public static final RankType SERIES

SUBSERIES

public static final RankType SUBSERIES

INFRAGENERICNNAME

public static final RankType INFRAGENERICNNAME

SPECIES

public static final RankType SPECIES

INFRASPECIFICNAME

public static final RankType INFRASPECIFICNAME

SUBSPECIES

public static final RankType SUBSPECIES

INFRASUBSPECIESNAME

public static final RankType INFRASUBSPECIESNAME

VARIETY

public static final RankType VARIETY

SUBVARIETY

public static final RankType SUBVARIETY

FORM

public static final RankType FORM

SUBFORM

public static final RankType SUBFORM

CULTIVARGROUP

public static final RankType CULTIVARGROUP

CULTIVAR

public static final RankType CULTIVAR

INFORMAL

public static final RankType INFORMAL

UNRANKED

public static final RankType UNRANKED

SUPRAGENERICNAME

public static final RankType SUPRAGENERICNAME

HYBRID

public static final RankType HYBRID

Method Detail

values

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

Returns:

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

valueOf

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

getAllRanksBelow

public static java.util.Set<RankType> getAllRanksBelow(java.lang.Integer rank)

getId

public java.lang.Integer getId()

Returns:

id the id

getRank

public java.lang.String getRank()

Returns:

field the field

getForStrRank

public static RankType getForStrRank(java.lang.String rank)

Gets the Rank Type for the supplied raw string...

Parameters:

rank -

Returns:

getBoost

public java.lang.Float getBoost()

getForName

public static RankType getForName(java.lang.String field)

Parameters:

field -

Returns:

The rankType for the field

getForCBRank

public static RankType getForCBRank(org.gbif.ecat.voc.Rank cbRank)

getForId

public static RankType getForId(java.lang.Integer id)

Parameters:

id -

Returns:

The RankType for the specified Portal id