Package org.biojava.nbio.structure
Class Compound
java.lang.Object
org.biojava.nbio.structure.Compound
- All Implemented Interfaces:
Serializable
An object to contain the info from the PDB header for a Molecule.
In mmCIF dictionary, it is called an Entity. In the case of polymers it
is defined as each group of sequence identical NCS-related chains
Now PDB file format 3.2 aware - contains the new TAX_ID fields for the
organism studied and the expression system.
- Since:
- 1.5
- Author:
- Jules Jacobsen, Jose Duarte
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add new Chain to this Compoundint
getAlignedResIndex
(Group g, Chain c) Given a Group g of Chain c (member of this Compound) return the corresponding position in the alignment of all member sequences (1-based numbering), i.e.getAtcc()
getCell()
Return the list of member chain IDs that are described by this Compound, only unique chain IDs are contained in the list.Get the list of chains that are part of this Compound.getGene()
getId()
get the ID used by Hibernateint
getMolId()
Return the molecule identifier, called entity_id in mmCIF dictionary.getOrgan()
Return the ref chain id value.Get the representative Chain for this Compound.getTitle()
void
void
setBiologicalUnit
(String biologicalUnit) void
void
setCellLine
(String cellLine) void
setCellularLocation
(String cellularLocation) void
Set the chains for this Compoundvoid
setDetails
(String details) void
void
setEngineered
(String engineered) void
setExpressionSystem
(String expressionSystem) void
setExpressionSystemAtccNumber
(String expressionSystemAtccNumber) void
setExpressionSystemCell
(String expressionSystemCell) void
setExpressionSystemCellLine
(String expressionSystemCellLine) void
setExpressionSystemCellularLocation
(String expressionSystemCellularLocation) void
setExpressionSystemGene
(String expressionSystemGene) void
setExpressionSystemOrgan
(String expressionSystemOrgan) void
setExpressionSystemOrganelle
(String expressionSystemOrganelle) void
setExpressionSystemOtherDetails
(String expressionSystemOtherDetails) void
setExpressionSystemPlasmid
(String expressionSystemPlasmid) void
setExpressionSystemStrain
(String expressionSystemStrain) void
setExpressionSystemTaxId
(String expressionSystemTaxId) void
setExpressionSystemTissue
(String expressionSystemTissue) void
setExpressionSystemVariant
(String expressionSystemVariant) void
setExpressionSystemVector
(String expressionSystemVector) void
setExpressionSystemVectorType
(String expressionSystemVectorType) void
setFragment
(String fragment) void
void
setHeaderVars
(String headerVars) void
set the ID used by Hibernatevoid
setMolId
(int molId) Set the molecule identifier, called entity_id in mmCIF dictionary.void
setMolName
(String molName) void
setMutation
(String mutation) void
void
void
setOrganelle
(String organelle) void
setOrganismCommon
(String organismCommon) void
setOrganismScientific
(String organismScientific) void
setOrganismTaxId
(String organismTaxId) void
setRefChainId
(String refChainId) Return the ref chain id value.void
setResNames
(String resNames) void
setSecretion
(String secretion) void
void
setSynonyms
(List<String> synonyms) void
setSynthetic
(String synthetic) void
void
void
setVariant
(String variant) void
void
Print some debug statements to System.outvoid
toString()
-
Constructor Details
-
Compound
public Compound() -
Compound
Constructs a new Compound copying all data from the given one but not setting the Chains- Parameters:
c
-
-
-
Method Details
-
toString
-
getRepresentative
Get the representative Chain for this Compound. We choose the Chain with the first chain identifier after lexicographical sorting (case insensitive), e.g. chain A if Compound is composed of chains A,B,C,D,E- Returns:
-
getId
get the ID used by Hibernate- Returns:
- the ID used by Hibernate
-
setId
set the ID used by Hibernate- Parameters:
id
-
-
showHeader
public void showHeader()Print some debug statements to System.out -
showCompound
public void showCompound() -
showSource
public void showSource() -
getChainIds
Return the list of member chain IDs that are described by this Compound, only unique chain IDs are contained in the list. Note that in the case of multimodel structures this will return just the unique chain identifiers whilstgetChains()
will return a corresponding chain per model.- Returns:
- the list of unique ChainIDs that are described by this Compound
- See Also:
-
getAlignedResIndex
Given a Group g of Chain c (member of this Compound) return the corresponding position in the alignment of all member sequences (1-based numbering), i.e. the index (1-based) in the SEQRES sequence. This allows for comparisons of residues belonging to different chains of the same Compound (entity).If
FileParsingParameters.setAlignSeqRes(boolean)
is not used or SEQRES not present, a mapping will not be available and this method will returnResidueNumber.getSeqNum()
for all residues, which in some cases will be correctly aligned indices (when no insertion codes are used and when all chains within the entity are numbered in the same way), but in general they will be neither unique (because of insertion codes) nor aligned.- Parameters:
g
-c
-- Returns:
- the aligned residue index (1 to n), if no SEQRES groups are available at all then
ResidueNumber.getSeqNum()
is returned as a fall-back, if the group is not found in the SEQRES groups then -1 is returned for the given group and chain - Throws:
IllegalArgumentException
- if the given Chain is not a member of this Compound
-
getRefChainId
Return the ref chain id value.- Returns:
- the RefChainID
- See Also:
-
setRefChainId
Return the ref chain id value.- Parameters:
refChainId
- the RefChainID- See Also:
-
getMolId
public int getMolId()Return the molecule identifier, called entity_id in mmCIF dictionary.- Returns:
- the molecule id
- See Also:
-
setMolId
public void setMolId(int molId) Set the molecule identifier, called entity_id in mmCIF dictionary.- Parameters:
molId
- the molecule id- See Also:
-
getMolName
-
setMolName
-
getTitle
-
setTitle
-
getSynonyms
-
setSynonyms
-
getEcNums
-
setEcNums
-
getEngineered
-
setEngineered
-
getMutation
-
setMutation
-
getBiologicalUnit
-
setBiologicalUnit
-
getDetails
-
setDetails
-
getNumRes
-
setNumRes
-
getResNames
-
setResNames
-
getHeaderVars
-
setHeaderVars
-
getSynthetic
-
setSynthetic
-
getFragment
-
setFragment
-
getOrganismScientific
-
setOrganismScientific
-
getOrganismTaxId
-
setOrganismTaxId
-
getOrganismCommon
-
setOrganismCommon
-
getStrain
-
setStrain
-
getVariant
-
setVariant
-
getCellLine
-
setCellLine
-
getAtcc
-
setAtcc
-
getOrgan
-
setOrgan
-
getTissue
-
setTissue
-
getCell
-
setCell
-
getOrganelle
-
setOrganelle
-
getSecretion
-
setSecretion
-
getGene
-
setGene
-
getCellularLocation
-
setCellularLocation
-
getExpressionSystem
-
getExpressionSystemTaxId
-
setExpressionSystemTaxId
-
setExpressionSystem
-
getExpressionSystemStrain
-
setExpressionSystemStrain
-
getExpressionSystemVariant
-
setExpressionSystemVariant
-
getExpressionSystemCellLine
-
setExpressionSystemCellLine
-
getExpressionSystemAtccNumber
-
setExpressionSystemAtccNumber
-
getExpressionSystemOrgan
-
setExpressionSystemOrgan
-
getExpressionSystemTissue
-
setExpressionSystemTissue
-
getExpressionSystemCell
-
setExpressionSystemCell
-
getExpressionSystemOrganelle
-
setExpressionSystemOrganelle
-
getExpressionSystemCellularLocation
-
setExpressionSystemCellularLocation
-
getExpressionSystemVectorType
-
setExpressionSystemVectorType
-
getExpressionSystemVector
-
setExpressionSystemVector
-
getExpressionSystemPlasmid
-
setExpressionSystemPlasmid
-
getExpressionSystemGene
-
setExpressionSystemGene
-
getExpressionSystemOtherDetails
-
setExpressionSystemOtherDetails
-
getChains
Get the list of chains that are part of this Compound. Note that for multi-model structures chains from all models are returned.- Returns:
- a List of Chain objects
-
addChain
Add new Chain to this Compound- Parameters:
chain
-
-
setChains
Set the chains for this Compound- Parameters:
chains
-
-