Package org.biojava.nbio.structure

Class ResidueNumber

java.lang.Object

org.biojava.nbio.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

Constructors

Constructor	Description
ResidueNumber()
ResidueNumber(java.lang.String chainName, java.lang.Integer residueNumber, java.lang.Character insCode)
ResidueNumber(ResidueNumber o)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ResidueNumber other)	Compare residue numbers by chain, sequence number, and insertion code
int	compareToPositional(ResidueNumber other)	Compare residue numbers by sequence number and insertion code, ignoring the chain
boolean	equals(java.lang.Object obj)
boolean	equalsPositional(java.lang.Object obj)	Check if the seqNum and insertion code are equivalent, ignoring the chain
static ResidueNumber	fromString(java.lang.String pdb_code)	Convert a string representation of a residue number to a residue number object.
java.lang.String	getChainName()
java.lang.Character	getInsCode()
java.lang.Integer	getSeqNum()
int	hashCode()
java.lang.String	printFull()
void	setChainName(java.lang.String chainName)
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(ResidueNumber o)

ResidueNumber

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

Method Detail

getChainName

public java.lang.String getChainName()

setChainName

public void setChainName(java.lang.String chainName)

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

equalsPositional

public boolean equalsPositional(java.lang.Object obj)

Check if the seqNum and insertion code are equivalent, ignoring the chain

Parameters:

obj -

Returns:

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, or null if the input was null

compareTo

public int compareTo(ResidueNumber other)

Compare residue numbers by chain, sequence number, and insertion code

Specified by:

compareTo in interface java.lang.Comparable<ResidueNumber>

compareToPositional

public int compareToPositional(ResidueNumber other)

Compare residue numbers by sequence number and insertion code, ignoring the chain

Parameters:

other -

Returns:

printFull

public java.lang.String printFull()