Package org.biojava.nbio.ws.alignment.qblast

Enum BlastOutputParameterEnum

java.lang.Object

java.lang.Enum<BlastOutputParameterEnum>

org.biojava.nbio.ws.alignment.qblast.BlastOutputParameterEnum

All Implemented Interfaces:

Serializable, Comparable<BlastOutputParameterEnum>

public enum BlastOutputParameterEnum
extends Enum<BlastOutputParameterEnum>

Output parameters accepted by QBlast service.
Not all are mandatory. Certain parameters only work with a subset of other parameters in the list.

Taken from Blast URL API

Author:

Gediminas Rimsa

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALIGNMENT_VIEW
ALIGNMENTS
DATABASE_SORT
DESCRIPTIONS
DISPLAY_SORT
EXPECT_HIGH
EXPECT_LOW
FORMAT_ENTREZ_QUERY
FORMAT_OBJECT
FORMAT_TYPE
HSP_SORT
I_THRESH
MASK_CHAR
MASK_COLOR
NCBI_GI
NOHEADER
NUM_OVERVIEW
RID
SHOW_CDS_FEATURE
SHOW_LINKOUT
SHOW_OVERVIEW

Method Summary

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

ALIGNMENTS

public static final BlastOutputParameterEnum ALIGNMENTS

ALIGNMENT_VIEW

public static final BlastOutputParameterEnum ALIGNMENT_VIEW

DESCRIPTIONS

public static final BlastOutputParameterEnum DESCRIPTIONS

DATABASE_SORT

public static final BlastOutputParameterEnum DATABASE_SORT

DISPLAY_SORT

public static final BlastOutputParameterEnum DISPLAY_SORT

EXPECT_HIGH

public static final BlastOutputParameterEnum EXPECT_HIGH

EXPECT_LOW

public static final BlastOutputParameterEnum EXPECT_LOW

FORMAT_OBJECT

public static final BlastOutputParameterEnum FORMAT_OBJECT

FORMAT_ENTREZ_QUERY

public static final BlastOutputParameterEnum FORMAT_ENTREZ_QUERY

FORMAT_TYPE

public static final BlastOutputParameterEnum FORMAT_TYPE

HSP_SORT

public static final BlastOutputParameterEnum HSP_SORT

I_THRESH

public static final BlastOutputParameterEnum I_THRESH

MASK_CHAR

public static final BlastOutputParameterEnum MASK_CHAR

MASK_COLOR

public static final BlastOutputParameterEnum MASK_COLOR

NCBI_GI

public static final BlastOutputParameterEnum NCBI_GI

NOHEADER

public static final BlastOutputParameterEnum NOHEADER

NUM_OVERVIEW

public static final BlastOutputParameterEnum NUM_OVERVIEW

RID

public static final BlastOutputParameterEnum RID

SHOW_CDS_FEATURE

public static final BlastOutputParameterEnum SHOW_CDS_FEATURE

SHOW_LINKOUT

public static final BlastOutputParameterEnum SHOW_LINKOUT

SHOW_OVERVIEW

public static final BlastOutputParameterEnum SHOW_OVERVIEW

Method Detail

values

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

Returns:

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

valueOf

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