NCBIGenBankDivision (com.hfg API Documentation)

java.lang.Object
- com.hfg.bio.taxonomy.ncbi.NCBIGenBankDivision

All Implemented Interfaces:

SeqRepositoryDivision, Serializable
```
public class NCBIGenBankDivision
extends Object
implements SeqRepositoryDivision, Serializable
```
Enumerated list of NCBI GenBank divisions.
Based on division.dmp file in ftp://ftp.ncbi.nih.gov/pub/taxonomy/taxdump.tar.gz

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static NCBIGenBankDivision`	`BACTERIA` Bacteria BCT 0
`static NCBIGenBankDivision`	`CONSTRUCTED` Constructed sequences
`static NCBIGenBankDivision`	`ENVIRONMENTAL_SAMPLES` Environmental samples ENV 11 (Anonymous sequences cloned directly from the environment)
`static NCBIGenBankDivision`	`EST` EST sequences (Expressed Sequence Tags)
`static NCBIGenBankDivision`	`GSS` GSS sequences (Genome Survey Sequences)
`static NCBIGenBankDivision`	`HTC` HTC sequences (High Throughput cDNA sequences)
`static NCBIGenBankDivision`	`HTG` HTGS sequences (High Throughput Genomic sequences)
`static NCBIGenBankDivision`	`INVERTEBRATES` Invertebrates INV 1
`static NCBIGenBankDivision`	`MAMMALS` Mammals MAM 2
`static NCBIGenBankDivision`	`PATENT` Patent sequences
`static NCBIGenBankDivision`	`PHAGES` Phages PHG 3
`static NCBIGenBankDivision`	`PLANTS` Plants PLN 4
`static NCBIGenBankDivision`	`PRIMATES` Primates PRI 5
`static NCBIGenBankDivision`	`RODENTS` Rodents ROD 6
`static NCBIGenBankDivision`	`STS` STS sequences (Sequence Tagged Sites)
`static NCBIGenBankDivision`	`SYNTHETIC` Synthetic SYN 7
`static NCBIGenBankDivision`	`TSA` Transcriptome Shotgun Assembly sequences
`static NCBIGenBankDivision`	`UNASSIGNED` Unassigned UNA 8 (No species nodes should inherit this division assignment)
`static NCBIGenBankDivision`	`VERTEBRATES` Vertebrates VRT 10
`static NCBIGenBankDivision`	`VIRUSES` Viruses VRL 9

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCode()` Returns the 3-letter GenBank division code.
`Integer`	`getId()`
`String`	`name()`
`String`	`toString()` The same as name().
`static NCBIGenBankDivision`	`valueOf(int inId)` Returns the corresponding NCBIGenBankDivision by comparing the id to the id values of the enumerated set.
`static NCBIGenBankDivision`	`valueOf(String inValue)` Returns the corresponding NCBIGenBankDivision by comparing the value to the name, code, and id values of the enumerated set.
`static Collection<NCBIGenBankDivision>`	`values()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - BACTERIA
```
public static NCBIGenBankDivision BACTERIA
```
    Bacteria BCT 0
  - INVERTEBRATES
```
public static NCBIGenBankDivision INVERTEBRATES
```
    Invertebrates INV 1
  - MAMMALS
```
public static NCBIGenBankDivision MAMMALS
```
    Mammals MAM 2
  - PHAGES
```
public static NCBIGenBankDivision PHAGES
```
    Phages PHG 3
  - PLANTS
```
public static NCBIGenBankDivision PLANTS
```
    Plants PLN 4
  - PRIMATES
```
public static NCBIGenBankDivision PRIMATES
```
    Primates PRI 5
  - RODENTS
```
public static NCBIGenBankDivision RODENTS
```
    Rodents ROD 6
  - SYNTHETIC
```
public static NCBIGenBankDivision SYNTHETIC
```
    Synthetic SYN 7
  - UNASSIGNED
```
public static NCBIGenBankDivision UNASSIGNED
```
    Unassigned UNA 8 (No species nodes should inherit this division assignment)
  - VIRUSES
```
public static NCBIGenBankDivision VIRUSES
```
    Viruses VRL 9
  - VERTEBRATES
```
public static NCBIGenBankDivision VERTEBRATES
```
    Vertebrates VRT 10
  - ENVIRONMENTAL_SAMPLES
```
public static NCBIGenBankDivision ENVIRONMENTAL_SAMPLES
```
    Environmental samples ENV 11 (Anonymous sequences cloned directly from the environment)
  - CONSTRUCTED
```
public static NCBIGenBankDivision CONSTRUCTED
```
    Constructed sequences
  - EST
```
public static NCBIGenBankDivision EST
```
    EST sequences (Expressed Sequence Tags)
  - PATENT
```
public static NCBIGenBankDivision PATENT
```
    Patent sequences
  - STS
```
public static NCBIGenBankDivision STS
```
    STS sequences (Sequence Tagged Sites)
  - GSS
```
public static NCBIGenBankDivision GSS
```
    GSS sequences (Genome Survey Sequences)
  - HTG
```
public static NCBIGenBankDivision HTG
```
    HTGS sequences (High Throughput Genomic sequences)
  - HTC
```
public static NCBIGenBankDivision HTC
```
    HTC sequences (High Throughput cDNA sequences)
  - TSA
```
public static NCBIGenBankDivision TSA
```
    Transcriptome Shotgun Assembly sequences
- Method Detail
  - values
```
public static Collection<NCBIGenBankDivision> values()
```
  - valueOf
```
public static NCBIGenBankDivision valueOf(int inId)
```
    Returns the corresponding NCBIGenBankDivision by comparing the id to the id values of the enumerated set.
    
    Parameters:
    
    inId - the id of the GenBank division to retrieve
    
    Returns:
    
    NCBIGenBankDivsion object corresponding to the specified id
  - valueOf
```
public static NCBIGenBankDivision valueOf(String inValue)
```
    Returns the corresponding NCBIGenBankDivision by comparing the value to the name, code, and id values of the enumerated set.
    
    Parameters:
    
    inValue - the name, code, or id of the GenBank division to retrieve
    
    Returns:
    
    NCBIGenBankDivsion object corresponding to the specified value
  - name
```
public String name()
```
    Specified by:
    
    name in interface SeqRepositoryDivision
  - toString
```
public String toString()
```
    The same as name().
    
    Overrides:
    
    toString in class Object
  - getCode
```
public String getCode()
```
    Returns the 3-letter GenBank division code.
    
    Specified by:
    
    getCode in interface SeqRepositoryDivision
    
    Returns:
    
    the 3-letter GenBank division code
  - getId
```
public Integer getId()
```

Class NCBIGenBankDivision

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BACTERIA

INVERTEBRATES

MAMMALS

PHAGES

PLANTS

PRIMATES

RODENTS

SYNTHETIC

UNASSIGNED

VIRUSES

VERTEBRATES

ENVIRONMENTAL_SAMPLES

CONSTRUCTED

EST

PATENT

STS

GSS

HTG

HTC

TSA

Method Detail

values

valueOf

valueOf

name

toString

getCode

getId