org.proteinshader.structure.io.enums
Enum RecordEnum

java.lang.Object
  java.lang.Enum<RecordEnum>
      org.proteinshader.structure.io.enums.RecordEnum

All Implemented Interfaces:

Serializable, Comparable<RecordEnum>

public enum RecordEnum
extends Enum<RecordEnum>

This file provides an enumeration of the record types defined in the Protein Data Bank Content Guide (Version 2.2, 20 Dec 1996).

This enumeration is intended to be used by a parser for ".pdb" files. Each enum type has three pieces of associated data:

1. The 6 character record name (which may include blank spaces).
2. The full name of the record (short enough to use in a menu).
3. A category name (short enough to be used in a menu).

In the Enum Constant Summary, the description is followed by the record category in parentheses.

Enum Constant Summary

ANISOU
Anisotropic T Factor Record (CategoryEnum.COORDINATES)

ATOM
Atom Record (CategoryEnum.COORDINATES)

AUTHOR
Author Record (CategoryEnum.TITLE_SECTION)

CAVEAT
Caveat Record (CategoryEnum.TITLE_SECTION)

CISPEP
Cis-Peptides Record (CategoryEnum.CONNECTIVITY_NOTES)

COMPND
Compound Description Record (CategoryEnum.TITLE_SECTION)

CONECT
Atom Connectivity Record (CategoryEnum.CONNECTIVITY)

CRYST1
Crystal Parameters Record (CategoryEnum.TRANSFORMATIONS)

DBREF
Database Reference Record (CategoryEnum.SEQUENCE_INFO)

END
End of PDB File Record (CategoryEnum.BOOKKEEPING)

ENDMDL
End of Model Record (CategoryEnum.COORDINATES)

EXPDTA
Experimental Data Record (CategoryEnum.TITLE_SECTION)

FORMUL
Heterogen Formula Record (CategoryEnum.HETEROGEN_INFO)

FTNOTE
Deprecated (CategoryEnum.MISCELLANEOUS)

HEADER
Header Record (CategoryEnum.TITLE_SECTION)

HELIX
Helix Info Record (CategoryEnum.SECONDARY_STRUCTURE)

HET
Heterogen Group Record (CategoryEnum.HETEROGEN_INFO)

HETATM
Heterogen Atom Record (CategoryEnum.COORDINATES)

HETNAM
Heterogen Name Record (CategoryEnum.HETEROGEN_INFO)

HETSYN
Heterogen Synonyms Record (CategoryEnum.HETEROGEN_INFO)

HYDBND
Hydrogen Bonds Record (CategoryEnum.CONNECTIVITY_NOTES)

JRNL
Journal Citation Record (CategoryEnum.TITLE_SECTION)

KEYWDS
Key Words Record (CategoryEnum.TITLE_SECTION)

LINK
Links Record (CategoryEnum.CONNECTIVITY_NOTES)

MASTER
Master Checksums Record (CategoryEnum.BOOKKEEPING)

MODEL
Model Record (CategoryEnum.COORDINATES)

MODRES
Modified Residues Record (CategoryEnum.SEQUENCE_INFO)

MTRIX1
MTRIX Matrix Row 1 Record (CategoryEnum.TRANSFORMATIONS)

MTRIX2
MTRIX Matrix Row 2 Record (CategoryEnum.TRANSFORMATIONS)

MTRIX3
MTRIX Matrix Row 3 Record (CategoryEnum.TRANSFORMATIONS)

OBSLTE
Obsolete Entry Info Record (CategoryEnum.TITLE_SECTION)

ORIGX1
ORIGX Matrix Row 1 Record (CategoryEnum.TRANSFORMATIONS)

ORIGX2
ORIGX Matrix Row 2 Record (CategoryEnum.TRANSFORMATIONS)

ORIGX3
ORIGX Matrix Row 3 Record (CategoryEnum.TRANSFORMATIONS)

REMARK
Remark Record (CategoryEnum.TITLE_SECTION)

REVDAT
Revision History Record (CategoryEnum.TITLE_SECTION)

SCALE1
Scale Matrix Row 1 Record (CategoryEnum.TRANSFORMATIONS)

SCALE2
Scale Matrix Row 2 Record (CategoryEnum.TRANSFORMATIONS)

SCALE3
Scale Matrix Row 3 Record (CategoryEnum.TRANSFORMATIONS)

SEQADV
Sequence Conflicts Record (CategoryEnum.SEQUENCE_INFO)

SEQRES
Sequence Residues Record (CategoryEnum.SEQUENCE_INFO)

SHEET
Beta-Sheet Info Record (CategoryEnum.SECONDARY_STRUCTURE)

SIGATM
Atom Std Dev Record (CategoryEnum.COORDINATES)

SIGUIJ
Anisotropic Std Dev Record (CategoryEnum.COORDINATES)

SITE
Important Sites Record (CategoryEnum.MISCELLANEOUS)

SLTBRG
Salt Bridges Record (CategoryEnum.CONNECTIVITY_NOTES)

SOURCE
Molecule Source Record (CategoryEnum.TITLE_SECTION)

SPRSDE
Supercedes Info Record (CategoryEnum.TITLE_SECTION)

SSBOND
Disulfide Bonds Record (CategoryEnum.CONNECTIVITY_NOTES)

TER
Chain Termination Record (CategoryEnum.COORDINATES)

TITLE
Title Record (CategoryEnum.TITLE_SECTION)

TURN
Turn Info Record (CategoryEnum.SECONDARY_STRUCTURE)

TVECT
Translation Vector Record (CategoryEnum.TRANSFORMATIONS)

Method Summary

String	getCategory() Returns a category for a PDB record.
CategoryEnum	getCategoryEnum() Returns a category enum for a PDB record.
String	getFullName() Returns the full name of the record type as a String.
String	getSixCharName() Returns the 6 character name for a PDB record type.
static RecordEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static RecordEnum[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HEADER

public static final RecordEnum HEADER

Header Record (CategoryEnum.TITLE_SECTION)

OBSLTE

public static final RecordEnum OBSLTE

Obsolete Entry Info Record (CategoryEnum.TITLE_SECTION)

TITLE

public static final RecordEnum TITLE

Title Record (CategoryEnum.TITLE_SECTION)

CAVEAT

public static final RecordEnum CAVEAT

Caveat Record (CategoryEnum.TITLE_SECTION)

COMPND

public static final RecordEnum COMPND

Compound Description Record (CategoryEnum.TITLE_SECTION)

SOURCE

public static final RecordEnum SOURCE

Molecule Source Record (CategoryEnum.TITLE_SECTION)

KEYWDS

public static final RecordEnum KEYWDS

Key Words Record (CategoryEnum.TITLE_SECTION)

EXPDTA

public static final RecordEnum EXPDTA

Experimental Data Record (CategoryEnum.TITLE_SECTION)

AUTHOR

public static final RecordEnum AUTHOR

Author Record (CategoryEnum.TITLE_SECTION)

REVDAT

public static final RecordEnum REVDAT

Revision History Record (CategoryEnum.TITLE_SECTION)

SPRSDE

public static final RecordEnum SPRSDE

Supercedes Info Record (CategoryEnum.TITLE_SECTION)

JRNL

public static final RecordEnum JRNL

Journal Citation Record (CategoryEnum.TITLE_SECTION)

REMARK

public static final RecordEnum REMARK

Remark Record (CategoryEnum.TITLE_SECTION)

DBREF

public static final RecordEnum DBREF

Database Reference Record (CategoryEnum.SEQUENCE_INFO)

SEQADV

public static final RecordEnum SEQADV

Sequence Conflicts Record (CategoryEnum.SEQUENCE_INFO)

SEQRES

public static final RecordEnum SEQRES

Sequence Residues Record (CategoryEnum.SEQUENCE_INFO)

MODRES

public static final RecordEnum MODRES

Modified Residues Record (CategoryEnum.SEQUENCE_INFO)

HET

public static final RecordEnum HET

Heterogen Group Record (CategoryEnum.HETEROGEN_INFO)

HETNAM

public static final RecordEnum HETNAM

Heterogen Name Record (CategoryEnum.HETEROGEN_INFO)

HETSYN

public static final RecordEnum HETSYN

Heterogen Synonyms Record (CategoryEnum.HETEROGEN_INFO)

FORMUL

public static final RecordEnum FORMUL

Heterogen Formula Record (CategoryEnum.HETEROGEN_INFO)

HELIX

public static final RecordEnum HELIX

Helix Info Record (CategoryEnum.SECONDARY_STRUCTURE)

SHEET

public static final RecordEnum SHEET

Beta-Sheet Info Record (CategoryEnum.SECONDARY_STRUCTURE)

TURN

public static final RecordEnum TURN

Turn Info Record (CategoryEnum.SECONDARY_STRUCTURE)

SSBOND

public static final RecordEnum SSBOND

Disulfide Bonds Record (CategoryEnum.CONNECTIVITY_NOTES)

LINK

public static final RecordEnum LINK

Links Record (CategoryEnum.CONNECTIVITY_NOTES)

HYDBND

public static final RecordEnum HYDBND

Hydrogen Bonds Record (CategoryEnum.CONNECTIVITY_NOTES)

SLTBRG

public static final RecordEnum SLTBRG

Salt Bridges Record (CategoryEnum.CONNECTIVITY_NOTES)

CISPEP

public static final RecordEnum CISPEP

Cis-Peptides Record (CategoryEnum.CONNECTIVITY_NOTES)

SITE

public static final RecordEnum SITE

Important Sites Record (CategoryEnum.MISCELLANEOUS)

FTNOTE

public static final RecordEnum FTNOTE

Deprecated (CategoryEnum.MISCELLANEOUS)

CRYST1

public static final RecordEnum CRYST1

Crystal Parameters Record (CategoryEnum.TRANSFORMATIONS)

ORIGX1

public static final RecordEnum ORIGX1

ORIGX Matrix Row 1 Record (CategoryEnum.TRANSFORMATIONS)

ORIGX2

public static final RecordEnum ORIGX2

ORIGX Matrix Row 2 Record (CategoryEnum.TRANSFORMATIONS)

ORIGX3

public static final RecordEnum ORIGX3

ORIGX Matrix Row 3 Record (CategoryEnum.TRANSFORMATIONS)

SCALE1

public static final RecordEnum SCALE1

Scale Matrix Row 1 Record (CategoryEnum.TRANSFORMATIONS)

SCALE2

public static final RecordEnum SCALE2

Scale Matrix Row 2 Record (CategoryEnum.TRANSFORMATIONS)

SCALE3

public static final RecordEnum SCALE3

Scale Matrix Row 3 Record (CategoryEnum.TRANSFORMATIONS)

MTRIX1

public static final RecordEnum MTRIX1

MTRIX Matrix Row 1 Record (CategoryEnum.TRANSFORMATIONS)

MTRIX2

public static final RecordEnum MTRIX2

MTRIX Matrix Row 2 Record (CategoryEnum.TRANSFORMATIONS)

MTRIX3

public static final RecordEnum MTRIX3

MTRIX Matrix Row 3 Record (CategoryEnum.TRANSFORMATIONS)

TVECT

public static final RecordEnum TVECT

Translation Vector Record (CategoryEnum.TRANSFORMATIONS)

MODEL

public static final RecordEnum MODEL

Model Record (CategoryEnum.COORDINATES)

ATOM

public static final RecordEnum ATOM

Atom Record (CategoryEnum.COORDINATES)

SIGATM

public static final RecordEnum SIGATM

Atom Std Dev Record (CategoryEnum.COORDINATES)

ANISOU

public static final RecordEnum ANISOU

Anisotropic T Factor Record (CategoryEnum.COORDINATES)

SIGUIJ

public static final RecordEnum SIGUIJ

Anisotropic Std Dev Record (CategoryEnum.COORDINATES)

TER

public static final RecordEnum TER

Chain Termination Record (CategoryEnum.COORDINATES)

HETATM

public static final RecordEnum HETATM

Heterogen Atom Record (CategoryEnum.COORDINATES)

ENDMDL

public static final RecordEnum ENDMDL

End of Model Record (CategoryEnum.COORDINATES)

CONECT

public static final RecordEnum CONECT

Atom Connectivity Record (CategoryEnum.CONNECTIVITY)

MASTER

public static final RecordEnum MASTER

Master Checksums Record (CategoryEnum.BOOKKEEPING)

END

public static final RecordEnum END

End of PDB File Record (CategoryEnum.BOOKKEEPING)

Method Detail

values

public static final RecordEnum[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(RecordEnum c : RecordEnum.values())
        System.out.println(c);

Returns:

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

valueOf

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

getSixCharName

public String getSixCharName()

Returns the 6 character name for a PDB record type.

Returns:

The record name found in the first 6 columns of a line in a PDB file.

getFullName

public String getFullName()

Returns the full name of the record type as a String.

Returns:

A few words describing the record type.

getCategory

public String getCategory()

Returns a category for a PDB record. The category is intended to be useful as a name to present in a menu.

Returns:

The record category as a String.

getCategoryEnum

public CategoryEnum getCategoryEnum()

Returns a category enum for a PDB record. The category is intended to be useful in a switch statement for parsing purposes.

Returns:

The record category as a CategoryEnum.