org.biopax.paxtools.search

Enum SearchEngine.HitAnnotation

java.lang.Object

java.lang.Enum<SearchEngine.HitAnnotation>

org.biopax.paxtools.search.SearchEngine.HitAnnotation

All Implemented Interfaces:

Serializable, Comparable<SearchEngine.HitAnnotation>

Enclosing class:

SearchEngine

public static enum SearchEngine.HitAnnotation
extends Enum<SearchEngine.HitAnnotation>

A Key for the value in a BioPAX element's annotations map where additional information about corresponding search hit will be stored.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIT_DATASOURCE
HIT_EXCERPT
HIT_ORGANISM
HIT_PATHWAY
HIT_SIZE

Method Summary

Modifier and Type	Method and Description
static SearchEngine.HitAnnotation	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchEngine.HitAnnotation[]	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

HIT_EXCERPT

public static final SearchEngine.HitAnnotation HIT_EXCERPT

HIT_SIZE

public static final SearchEngine.HitAnnotation HIT_SIZE

HIT_ORGANISM

public static final SearchEngine.HitAnnotation HIT_ORGANISM

HIT_DATASOURCE

public static final SearchEngine.HitAnnotation HIT_DATASOURCE

HIT_PATHWAY

public static final SearchEngine.HitAnnotation HIT_PATHWAY

Method Detail

values

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

Returns:

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

valueOf

public static SearchEngine.HitAnnotation valueOf(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:

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

NullPointerException - if the argument is null