forked from jonalv/cdk
/
SymbolMatcher.java
67 lines (62 loc) · 2.4 KB
/
SymbolMatcher.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
* Copyright (C) 2012 John May <jwmay@sf.net>
*
* Contact: cdk-devel@lists.sourceforge.net
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package org.openscience.cdk.isomorphism.matchers.atom;
import org.openscience.cdk.annotations.TestClass;
import org.openscience.cdk.annotations.TestMethod;
import org.openscience.cdk.interfaces.IAtom;
/**
* An {@link org.openscience.cdk.isomorphism.matchers.IAtomMatcher} for atom symbols. This method
* determines whether the symbols of an atom ({@link org.openscience.cdk.interfaces.IAtom#getSymbol()})
* are equal.
* <p/>
* This matcher is is the default matcher for the {@link org.openscience.cdk.isomorphism.UniversalIsomorphismTester}.
*
* @author John May
* @cdk.module standard
* @see org.openscience.cdk.isomorphism.UniversalIsomorphismTester
* @see org.openscience.cdk.interfaces.IAtom#getSymbol()
*/
@TestClass("org.openscience.cdk.isomorphism.matchers.SymbolMatcherTest")
public class SymbolMatcher extends AbstractAtomMatcher {
/**
* Provides the symbol of the atom as an attribute to match.
*
* @param atom The atom for which to get the symbol
*
* @return the symbol of the atom or null if the symbol is unset
*
* @see org.openscience.cdk.interfaces.IAtom#getSymbol()
*/
@Override
@TestMethod("testMatches,testMatches_Mismatch,"
+ "testMatches_QueryNull,testMatches_SubjectNull,testMatches_BothNull,"
+ "testGetAttribute_Null,testGetAttribute")
public Object getAttribute(IAtom atom) {
return atom.getSymbol();
}
/**
* @inheritDoc
*/
@Override
@TestMethod("testToString")
public String toString() {
return "query.getSymbol() == subject.getSymbol()";
}
}