StructureParserOptions.Setting (singa-structure 0.3.3 API)

java.lang.Object
- java.lang.Enum<StructureParserOptions.Setting>
- - de.bioforscher.singa.structure.parser.pdb.structures.StructureParserOptions.Setting

All Implemented Interfaces:

Serializable, Comparable<StructureParserOptions.Setting>

Enclosing class:

StructureParserOptions
```
public static enum StructureParserOptions.Setting
extends Enum<StructureParserOptions.Setting>
```
Settings that can be passed to the Options.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CREATE_EDGES` Create Edges in between leaf substructures (default).
`GET_HETERO_ATOMS` Parse atoms annotated as hetero atoms (default).
`GET_HYDROGEN_CONNECTIONS` Connect hydrogens to leafs.
`GET_HYDROGENS` Parse hydrogen atoms.
`GET_IDENTIFIER_FROM_FILENAME` Parse and use the first valid pdb identifier from the file name.
`GET_IDENTIFIER_FROM_PDB` Use the pdb file to infer the pdb identifier (default).
`GET_LIGAND_INFORMATION` Parse additional information for ligands form pdb (default).
`GET_TITLE_FROM_FILENAME` Use the file name as the title of the structure.
`GET_TITLE_FROM_PDB` Use the pdb file to infer the pdb title (default).
`OMIT_EDGES` Omit Edges between leaf substructures.
`OMIT_HETERO_ATOMS` Omit parsing of hetero atoms.
`OMIT_HYDROGENS` Omit hydrogen atoms (default).
`OMIT_HYDROGENS_CONNECTIONS` Omit hydrogen connections to leafs (default).
`OMIT_LIGAND_INFORMATION` Omit parsing of ligand information.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static StructureParserOptions.Setting`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static StructureParserOptions.Setting[]`	`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
  - CREATE_EDGES
```
public static final StructureParserOptions.Setting CREATE_EDGES
```
    Create Edges in between leaf substructures (default).
  - OMIT_EDGES
```
public static final StructureParserOptions.Setting OMIT_EDGES
```
    Omit Edges between leaf substructures.
  - GET_LIGAND_INFORMATION
```
public static final StructureParserOptions.Setting GET_LIGAND_INFORMATION
```
    Parse additional information for ligands form pdb (default).
  - OMIT_LIGAND_INFORMATION
```
public static final StructureParserOptions.Setting OMIT_LIGAND_INFORMATION
```
    Omit parsing of ligand information.
  - GET_HETERO_ATOMS
```
public static final StructureParserOptions.Setting GET_HETERO_ATOMS
```
    Parse atoms annotated as hetero atoms (default).
  - OMIT_HETERO_ATOMS
```
public static final StructureParserOptions.Setting OMIT_HETERO_ATOMS
```
    Omit parsing of hetero atoms.
  - GET_HYDROGEN_CONNECTIONS
```
public static final StructureParserOptions.Setting GET_HYDROGEN_CONNECTIONS
```
    Connect hydrogens to leafs.
  - OMIT_HYDROGENS_CONNECTIONS
```
public static final StructureParserOptions.Setting OMIT_HYDROGENS_CONNECTIONS
```
    Omit hydrogen connections to leafs (default).
  - GET_HYDROGENS
```
public static final StructureParserOptions.Setting GET_HYDROGENS
```
    Parse hydrogen atoms.
  - OMIT_HYDROGENS
```
public static final StructureParserOptions.Setting OMIT_HYDROGENS
```
    Omit hydrogen atoms (default).
  - GET_TITLE_FROM_FILENAME
```
public static final StructureParserOptions.Setting GET_TITLE_FROM_FILENAME
```
    Use the file name as the title of the structure.
  - GET_TITLE_FROM_PDB
```
public static final StructureParserOptions.Setting GET_TITLE_FROM_PDB
```
    Use the pdb file to infer the pdb title (default).
  - GET_IDENTIFIER_FROM_FILENAME
```
public static final StructureParserOptions.Setting GET_IDENTIFIER_FROM_FILENAME
```
    Parse and use the first valid pdb identifier from the file name.
  - GET_IDENTIFIER_FROM_PDB
```
public static final StructureParserOptions.Setting GET_IDENTIFIER_FROM_PDB
```
    Use the pdb file to infer the pdb identifier (default).
- Method Detail
  - values
```
public static StructureParserOptions.Setting[] 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 (StructureParserOptions.Setting c : StructureParserOptions.Setting.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StructureParserOptions.Setting 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

Enum StructureParserOptions.Setting

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CREATE_EDGES

OMIT_EDGES

GET_LIGAND_INFORMATION

OMIT_LIGAND_INFORMATION

GET_HETERO_ATOMS

OMIT_HETERO_ATOMS

GET_HYDROGEN_CONNECTIONS

OMIT_HYDROGENS_CONNECTIONS

GET_HYDROGENS

OMIT_HYDROGENS

GET_TITLE_FROM_FILENAME

GET_TITLE_FROM_PDB

GET_IDENTIFIER_FROM_FILENAME

GET_IDENTIFIER_FROM_PDB

Method Detail

values

valueOf