The Octet Molecular Representation Framework v0.8.2

net.sf.octet.query
Class BasicConfigurationComparator

java.lang.Object
  extended bynet.sf.octet.query.BasicConfigurationComparator
All Implemented Interfaces:
ConfigurationComparator

public class BasicConfigurationComparator
extends java.lang.Object
implements ConfigurationComparator

A default implementation of the ConfigurationComparator interface.

Author:
Richard Apodaca

Method Summary
 boolean compare(Configuration input, Configuration model, AtomMap map)
          Compares input with model using map to correlate Atoms between the two.
static ConfigurationComparator getBilateralInstance()
          Returns a bilateral ConfigurationComparator as a singleton instance.
static ConfigurationComparator getUnilateralInstance()
          Returns a unilateral ConfigurationComparator 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(Configuration input,
                       Configuration model,
                       AtomMap map)
Description copied from interface: ConfigurationComparator
Compares input with model using map to correlate Atoms between the two. Returns true if commonality was detected, or false otherwise.

Specified by:
compare in interface ConfigurationComparator
Parameters:
input - the Configuration whose features will be compared with those of model using map
model - the reference Configuration
map - the mapping of the atoms of input onto map
Returns:
true if the comparison was positive or false otherwise

getUnilateralInstance

public static ConfigurationComparator getUnilateralInstance()
Returns a unilateral ConfigurationComparator as a singleton instance.

Returns:
a unilateral ConfigurationComparator as a singleton instance

getBilateralInstance

public static ConfigurationComparator getBilateralInstance()
Returns a bilateral ConfigurationComparator as a singleton instance.

Returns:
a bilateral ConfigurationComparator as a singleton instance

The Octet Molecular Representation Framework v0.8.2