Package org.biojava.nbio.structure.cath
Class CathDomain
java.lang.Object
org.biojava.nbio.structure.cath.CathDomain
- All Implemented Interfaces:
 Serializable,StructureIdentifier
A class which represents a single CATH domain.
- See Also:
 
- 
Field Summary
Fields - 
Constructor Summary
Constructors - 
Method Summary
Modifier and TypeMethodDescriptiongetCATH()Returns the chains this domain is defined over; contains more than 1 element only if this domains is a multi-chain domain.getClassificationId(CathCategory cathCategory) getDate()Get the String form of this identifier.getName()getPdbId()Deprecated.Returns a string of the formPDBID.CHAIN.getSOILD()Returns the PDB ID.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.voidsetArchitectureId(Integer architectureId) voidvoidsetClassId(Integer classId) voidsetComment(String comment) voidvoidsetDomainCounter(Integer domainCounter) voidsetDomainName(String domainName) voidvoidsetHomologyId(Integer homologyId) voidsetIdenticalSequenceFamilyId(Integer identicalSequenceFamilyId) voidvoidsetLikeSequenceFamilyId(Integer likeSequenceFamilyId) voidvoidsetOrthologousSequenceFamilyId(Integer orthologousSequenceFamilyId) voidsetResolution(Double resolution) voidsetSegments(List<CathSegment> segments) voidsetSequence(String sequence) voidsetSequenceFamilyId(Integer sequenceFamilyId) voidsetSequenceHeader(String sequenceHeader) voidvoidvoidsetTopologyId(Integer topologyId) voidsetVersion(String version) Convert to a canonical SubstructureIdentifier.toString() 
- 
Field Details
- 
serialVersionUID
public static final long serialVersionUID- See Also:
 
 
 - 
 - 
Constructor Details
- 
CathDomain
public CathDomain() 
 - 
 - 
Method Details
- 
getDomainName
 - 
setDomainName
 - 
getPdbId
Deprecated.This method is poorly named; usegetThePdbId()orgetPdbIdAndChain()insteadReturns a string of the formPDBID.CHAIN. For example:1hiv.A. - 
getThePdbId
Returns the PDB ID. - 
getPdbIdAndChain
Returns a string of the formPDBID.CHAIN. For example:1hiv.A. - 
getDomainId
 - 
getClassId
 - 
setClassId
 - 
getArchitectureId
 - 
setArchitectureId
 - 
getTopologyId
 - 
setTopologyId
 - 
getHomologyId
 - 
setHomologyId
 - 
getSequenceFamilyId
 - 
setSequenceFamilyId
 - 
getOrthologousSequenceFamilyId
 - 
setOrthologousSequenceFamilyId
 - 
getLikeSequenceFamilyId
 - 
setLikeSequenceFamilyId
 - 
getIdenticalSequenceFamilyId
 - 
setIdenticalSequenceFamilyId
 - 
getDomainCounter
 - 
setDomainCounter
 - 
getLength
 - 
setLength
 - 
getResolution
 - 
setResolution
 - 
setCATH
 - 
getCATH
 - 
setSOLID
 - 
getSOILD
 - 
getClassificationId
 - 
getFormat
 - 
setFormat
 - 
getVersion
 - 
setVersion
 - 
getDate
 - 
setDate
 - 
getName
 - 
setName
 - 
getSource
 - 
setSource
 - 
getSequenceHeader
 - 
setSequenceHeader
 - 
getSequence
 - 
setSequence
 - 
getSegments
 - 
setSegments
 - 
getComment
 - 
setComment
 - 
toString
 - 
getChains
Returns the chains this domain is defined over; contains more than 1 element only if this domains is a multi-chain domain. - 
getIdentifier
Description copied from interface:StructureIdentifierGet the String form of this identifier. It is recommended that the#toString()method also return the identifier, for consistency during serialization.- Specified by:
 getIdentifierin interfaceStructureIdentifier- Returns:
 - The String form of this identifier
 
 - 
toCanonical
Description copied from interface:StructureIdentifierConvert to a canonical SubstructureIdentifier.This allows all domains to be converted to a standard format String.
- Specified by:
 toCanonicalin interfaceStructureIdentifier- Returns:
 - A SubstructureIdentifier equivalent to this
 
 - 
reduce
Description copied from interface:StructureIdentifierTakes 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:
 reducein 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:
 
 - 
loadStructure
Description copied from interface:StructureIdentifierLoads 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:
 loadStructurein 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
 
 - 
 
getThePdbId()orgetPdbIdAndChain()instead