net.sf.octet.query
Interface AtomQuery

All Known Implementing Classes:

TemplateAtomQuery, WildcardAtomQuery

public interface AtomQuery

The root interface for all Atom queries. AtomQueries are immutable in the sense that the match method will return the same result for the same Atom in the same Molecule over the lifetime of the AtomQuery.

Author:

Richard Apodaca

See Also:

"Immutable Pattern (Grand98)"

Method Summary

boolean

match(Atom atom, Molecule molecule) Returns true if this AtomQuery matches atom, or false otherwise.

Method Detail

match

public boolean match(Atom atom,
                     Molecule molecule)

Returns true if this AtomQuery matches atom, or false otherwise.

Parameters:

atom - the Atom to match

molecule - the Molecule in which atom resides

Returns:

true if a match was found, or false otherwise