Package org.biojava.nbio.structure

Enum ExperimentalTechnique

java.lang.Object

java.lang.Enum<ExperimentalTechnique>

org.biojava.nbio.structure.ExperimentalTechnique

All Implemented Interfaces:

Serializable, Comparable<ExperimentalTechnique>, java.lang.constant.Constable

public enum ExperimentalTechnique
extends Enum<ExperimentalTechnique>

An enum to represent the experimental technique of a PDB structure

Author:

duarte_j

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ELECTRON_CRYSTALLOGRAPHY
ELECTRON_MICROSCOPY
FIBER_DIFFRACTION
FLUORESCENCE_TRANSFER
INFRARED_SPECTROSCOPY
NEUTRON_DIFFRACTION
POWDER_DIFFRACTION
SOLID_STATE_NMR
SOLUTION_NMR
SOLUTION_SCATTERING
XRAY_DIFFRACTION

Method Summary

Modifier and Type	Method	Description
static ExperimentalTechnique	getByName(String expTechniqueName)	Returns the ExpTechnique given an experimental technique name as used in the PDB, e.g.
String	getName()
boolean	isCrystallographic()
static boolean	isCrystallographic(Set<ExperimentalTechnique> techniques)	Given a Set of ExperimentalTechniques returns true if at least one is crystallographic
boolean	isNmr()
static boolean	isNmr(Set<ExperimentalTechnique> techniques)	Given a Set of ExperimentalTechniques returns true if at least one is NMR
String	toString()
static ExperimentalTechnique	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ExperimentalTechnique[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

XRAY_DIFFRACTION

public static final ExperimentalTechnique XRAY_DIFFRACTION

SOLUTION_NMR

public static final ExperimentalTechnique SOLUTION_NMR

SOLID_STATE_NMR

public static final ExperimentalTechnique SOLID_STATE_NMR

ELECTRON_MICROSCOPY

public static final ExperimentalTechnique ELECTRON_MICROSCOPY

ELECTRON_CRYSTALLOGRAPHY

public static final ExperimentalTechnique ELECTRON_CRYSTALLOGRAPHY

FIBER_DIFFRACTION

public static final ExperimentalTechnique FIBER_DIFFRACTION

NEUTRON_DIFFRACTION

public static final ExperimentalTechnique NEUTRON_DIFFRACTION

SOLUTION_SCATTERING

public static final ExperimentalTechnique SOLUTION_SCATTERING

POWDER_DIFFRACTION

public static final ExperimentalTechnique POWDER_DIFFRACTION

FLUORESCENCE_TRANSFER

public static final ExperimentalTechnique FLUORESCENCE_TRANSFER

INFRARED_SPECTROSCOPY

public static final ExperimentalTechnique INFRARED_SPECTROSCOPY

Method Details

values

public static ExperimentalTechnique[] values()

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

Returns:

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

valueOf

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

getName

public String getName()

isCrystallographic

public boolean isCrystallographic()

isNmr

public boolean isNmr()

getByName

public static ExperimentalTechnique getByName(String expTechniqueName)

Returns the ExpTechnique given an experimental technique name as used in the PDB, e.g. "X-RAY DIFFRACTION" returns XRAY_DIFFRACTION

Parameters:

expTechniqueName - the ExpTechnique value or null if string doesn't match one of the known PDB experimental strings

Returns:

isCrystallographic

public static boolean isCrystallographic(Set<ExperimentalTechnique> techniques)

Given a Set of ExperimentalTechniques returns true if at least one is crystallographic

Returns:

true if at least 1 of the techniques is crystallographic, false if none of the techniques are crystallographic

Throws:

NullPointerException - if input is null

isNmr

public static boolean isNmr(Set<ExperimentalTechnique> techniques)

Given a Set of ExperimentalTechniques returns true if at least one is NMR

Returns:

true if at least 1 of the techniques is NMR, false if none of the techniques are NMR

Throws:

NullPointerException - if input is null

toString

public String toString()

Overrides:

toString in class Enum<ExperimentalTechnique>