net.sf.octet.query
Class BasicConformationComparator

java.lang.Object
  net.sf.octet.query.BasicConformationComparator

All Implemented Interfaces:

ConformationComparator

public class BasicConformationComparator

extends java.lang.Object

implements ConformationComparator

A default implementation of the ConformationComparator interface.

Author:

Richard Apodaca

Method Summary

boolean	compare(Conformation input, Conformation model, AtomMap map) Compares input to model, using the specified AtomMap to correlate Atoms between the two.
static ConformationComparator	getBilateralInstance() Returns a bilateral ConformationComparator as a singleton instance.
static ConformationComparator	getUnilateralInstance() Returns a unilateral ConformationComparator as a singleton instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

compare

public boolean compare(Conformation input,
                       Conformation model,
                       AtomMap map)

Description copied from interface: ConformationComparator

Compares input to model, using the specified AtomMap to correlate Atoms between the two. Returns true if a match was detected, or false otherwise.

Specified by:

compare in interface ConformationComparator

Parameters:

input - the Conformation whose features will be compared with those of model using map

model - the reference Conformation

map - the mapping of the atoms of input onto map

Returns:

true if the comparison was positive or false otherwise

getUnilateralInstance

public static ConformationComparator getUnilateralInstance()

Returns a unilateral ConformationComparator as a singleton instance.

Returns:

a unilateral ConformationComparator as a singleton instance

getBilateralInstance

public static ConformationComparator getBilateralInstance()

Returns a bilateral ConformationComparator as a singleton instance.

Returns:

a bilateral ConformationComparator as a singleton instance