Package org.biojava.nbio.structure.align.client

Class PdbPair

java.lang.Object

org.biojava.nbio.structure.align.client.PdbPair

All Implemented Interfaces:

java.lang.Comparable<PdbPair>

public class PdbPair
extends java.lang.Object
implements java.lang.Comparable<PdbPair>

A pair for structure alignment. a pair is considered equal to another pair if their two respective tuple poles are equal either in their original or reversed order. i.e. both new PdbPair("1abc", "2abc").equals(new PdbPair("1abc", "2abc")) and new PdbPair("1abc", "2abc").equals(new PdbPair("2abc", "1abc")) are true.

Author:

Andreas Prlic

Constructor Summary

Constructors

Constructor	Description
PdbPair(java.lang.String name1, java.lang.String name2)
PdbPair(StructureName name1, StructureName name2)

Method Summary

Modifier and Type	Method	Description
int	compareTo(PdbPair o)
boolean	equals(java.lang.Object obj)
java.lang.String	getChainId1()
java.lang.String	getChainId2()
java.lang.String	getName1()
java.lang.String	getName2()
java.lang.String	getPDBCode1()	Deprecated. use getPDBCode1() instead
java.lang.String	getPDBCode2()	Deprecated. use getPDBCode2() instead
PdbId	getPdbId1()
PdbId	getPdbId2()
PdbPair	getReverse()
int	hashCode()
void	setName1(java.lang.String name1)
void	setName2(java.lang.String name2)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PdbPair

public PdbPair(java.lang.String name1,
               java.lang.String name2)

PdbPair

public PdbPair(StructureName name1,
               StructureName name2)

Method Detail

getName1

public java.lang.String getName1()

setName1

public void setName1(java.lang.String name1)

getName2

public java.lang.String getName2()

setName2

public void setName2(java.lang.String name2)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(PdbPair o)

Specified by:

compareTo in interface java.lang.Comparable<PdbPair>

getPDBCode1

public java.lang.String getPDBCode1()
                             throws StructureException

Deprecated.

use getPDBCode1() instead

Returns:

Throws:

StructureException

getPDBCode2

@Deprecated
public java.lang.String getPDBCode2()
                             throws StructureException

Deprecated.

use getPDBCode2() instead

Returns:

Throws:

StructureException

getPdbId1

public PdbId getPdbId1()
                throws StructureException

Returns:

Throws:

StructureException

Since:

6.0.0

getPdbId2

public PdbId getPdbId2()
                throws StructureException

Returns:

Throws:

StructureException

Since:

6.0.0

getChainId1

public java.lang.String getChainId1()

getChainId2

public java.lang.String getChainId2()

getReverse

public PdbPair getReverse()