org.biojava.bio.structure

Class ResidueNumber

java.lang.Object

org.biojava.bio.structure.ResidueNumber

All Implemented Interfaces:

Serializable, Comparable<ResidueNumber>

public class ResidueNumber
extends Object
implements Serializable, Comparable<ResidueNumber>

Everything that is needed to uniquely describe a residue position

Author:

Andreas Prlic

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResidueNumber()
ResidueNumber(String chainId, Integer residueNumber, Character insCode)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ResidueNumber other)
boolean	equals(Object obj) Require chainId, insCode, and seqNum to be equal
static ResidueNumber	fromString(String pdb_code) Convert a string representation of a residue number to a residue number object.
String	getChainId()
Character	getInsCode()
Integer	getSeqNum()
int	hashCode()
void	setChainId(String chainId)
void	setInsCode(Character insCode)
void	setSeqNum(Integer seqNum)
String	toPDB()
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(String chainId,
             Integer residueNumber,
             Character insCode)

Method Detail

getChainId

public String getChainId()

setChainId

public void setChainId(String chainId)

getInsCode

public Character getInsCode()

setInsCode

public void setInsCode(Character insCode)

getSeqNum

public Integer getSeqNum()

setSeqNum

public void setSeqNum(Integer seqNum)

equals

public boolean equals(Object obj)

Require chainId, insCode, and seqNum to be equal

Overrides:

equals in class Object

Parameters:

obj -

Returns:

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

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

See Also:

Object.toString()

toPDB

public String toPDB()

Returns:

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

fromString

public static ResidueNumber fromString(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 Comparable<ResidueNumber>