org.biojava.bio.structure
Class ResidueNumber

java.lang.Object
  org.biojava.bio.structure.ResidueNumber

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ResidueNumber>

public class ResidueNumber
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<ResidueNumber>

Everything that is needed to uniquely describe a residue position

Author:

Andreas Prlic

See Also:

Serialized Form

Constructor Summary

ResidueNumber()

ResidueNumber(java.lang.String chainId, java.lang.Integer residueNumber, java.lang.Character insCode)

Method Summary

int	compareTo(ResidueNumber other)
boolean	equals(java.lang.Object obj)
static ResidueNumber	fromString(java.lang.String pdb_code) Convert a string representation of a residue number to a residue number object.
java.lang.String	getChainId()
java.lang.Character	getInsCode()
java.lang.Integer	getSeqNum()
int	hashCode()
void	setChainId(java.lang.String chainId)
void	setInsCode(java.lang.Character insCode)
void	setSeqNum(java.lang.Integer seqNum)
java.lang.String	toPDB()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResidueNumber

public ResidueNumber()

ResidueNumber

public ResidueNumber(java.lang.String chainId,
                     java.lang.Integer residueNumber,
                     java.lang.Character insCode)

Method Detail

getChainId

public java.lang.String getChainId()

setChainId

public void setChainId(java.lang.String chainId)

getInsCode

public java.lang.Character getInsCode()

setInsCode

public void setInsCode(java.lang.Character insCode)

getSeqNum

public java.lang.Integer getSeqNum()

setSeqNum

public void setSeqNum(java.lang.Integer seqNum)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

The residue number and insertion code as a string, eg "74A"

See Also:

Object.toString()

toPDB

public java.lang.String toPDB()

Returns:

The chain, number, and insertion code as a string, eg "B 74A" or "A 1 "

fromString

public static ResidueNumber fromString(java.lang.String pdb_code)

Convert a string representation of a residue number to a residue number object. The string representation can be a integer followed by a character.

Parameters:

pdb_code -

Returns:

a ResidueNumber object

compareTo

public int compareTo(ResidueNumber other)

Specified by:

compareTo in interface java.lang.Comparable<ResidueNumber>