Package org.rcsb.strucmotif.domain.motif

Class ResiduePairOccurrence

java.lang.Object

org.rcsb.strucmotif.domain.motif.ResiduePairOccurrence

public class ResiduePairOccurrence
extends Object

A residue pair occurrence is the combination of its properties (ResiduePairDescriptor) and both identifiers (wrapped as ResiduePairIdentifier).

Constructor Summary

Constructors

Constructor	Description
ResiduePairOccurrence(ResiduePairDescriptor residuePairDescriptor, ResiduePairIdentifier residuePairIdentifier)	Construct a pair occurrence.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ResiduePairIdentifier	getResidueIdentifier()	Where is this pair located?
ResiduePairDescriptor	getResiduePairDescriptor()	What are the properties of this pair?
int	hashCode()
Stream<ResiduePairDescriptor>	residuePairDescriptorsByTolerance(int backboneTolerance, int sideChainTolerance, int angleTolerance, Map<IndexSelection,Set<ResidueType>> exchanges)	Traverse all ResiduePairDescriptor instances which are compatible to this one given the specified parameters and registered position-specific exchanges (if any).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ResiduePairOccurrence

public ResiduePairOccurrence(ResiduePairDescriptor residuePairDescriptor,
 ResiduePairIdentifier residuePairIdentifier)

Construct a pair occurrence.

Parameters:

residuePairDescriptor - what are the properties of this pair?

residuePairIdentifier - where is this pair located?

Method Details

getResiduePairDescriptor

public ResiduePairDescriptor getResiduePairDescriptor()

What are the properties of this pair?

Returns:

a pair descriptor

getResidueIdentifier

public ResiduePairIdentifier getResidueIdentifier()

Where is this pair located?

Returns:

a pair identifier

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

residuePairDescriptorsByTolerance

public Stream<ResiduePairDescriptor> residuePairDescriptorsByTolerance(int backboneTolerance,
 int sideChainTolerance,
 int angleTolerance,
 Map<IndexSelection,Set<ResidueType>> exchanges)

Traverse all ResiduePairDescriptor instances which are compatible to this one given the specified parameters and registered position-specific exchanges (if any).

Parameters:

backboneTolerance - tolerance value

sideChainTolerance - tolerance value

angleTolerance - tolerance value

exchanges - map of position-specific exchanges - may be empty

Returns:

stream of all ResiduePairDescriptor instances formed