Package org.biojava.nbio.structure
Class BioAssemblyIdentifier
java.lang.Object
org.biojava.nbio.structure.BioAssemblyIdentifier
- All Implemented Interfaces:
StructureIdentifier
-
Field Summary
-
Constructor Summary
ConstructorDescriptionBioAssemblyIdentifier
(String name) BioAssemblyIdentifier
(String pdbCode, int biolNr) -
Method Summary
Modifier and TypeMethodDescriptionGet the String form of this identifier.loadStructure
(AtomCache cache) Loads a structure encompassing the structure identified.Takes a complete structure as input and reduces it to the substructure represented by this StructureIdentifier.Convert to a canonical SubstructureIdentifier.toString()
-
Field Details
-
BIO_NAME_PATTERN
-
-
Constructor Details
-
BioAssemblyIdentifier
-
BioAssemblyIdentifier
-
-
Method Details
-
getIdentifier
Description copied from interface:StructureIdentifier
Get the String form of this identifier. It is recommended that the#toString()
method also return the identifier, for consistency during serialization.- Specified by:
getIdentifier
in interfaceStructureIdentifier
- Returns:
- The String form of this identifier
-
toString
-
loadStructure
Description copied from interface:StructureIdentifier
Loads a structure encompassing the structure identified. The Structure returned should be suitable for passing as the input toStructureIdentifier.reduce(Structure)
. It is recommended that the most complete structure available be returned (e.g. the full PDB) to allow processing of unselected portions where appropriate.- Specified by:
loadStructure
in interfaceStructureIdentifier
- Returns:
- A Structure containing at least the atoms identified by this, or null if Structures are not applicable.
- Throws:
StructureException
- For errors loading and parsing the structureIOException
- Errors reading the structure from disk
-
toCanonical
Description copied from interface:StructureIdentifier
Convert to a canonical SubstructureIdentifier.This allows all domains to be converted to a standard format String.
- Specified by:
toCanonical
in interfaceStructureIdentifier
- Returns:
- A SubstructureIdentifier equivalent to this
- Throws:
StructureException
- Wraps exceptions that may be thrown by individual implementations. For example, a SCOP identifier may require that the domain definitions be available for download.
-
reduce
Description copied from interface:StructureIdentifier
Takes a complete structure as input and reduces it to the substructure represented by this StructureIdentifier.The returned structure may be a shallow copy of the input, with shared Chains, Residues, etc.
- Specified by:
reduce
in interfaceStructureIdentifier
- Parameters:
input
- A full structure, e.g. as loaded from the PDB. The structure ID should match that returned by getPdbId(), if applicable.- Returns:
- Throws:
StructureException
- See Also:
-