Package org.openscience.cdk.smarts
Class SmartsResult
- java.lang.Object
-
- org.openscience.cdk.smarts.SmartsResult
-
public class SmartsResult extends Object
The result of parsing a SMARTS. The result indicates if the input was parsed OK or not (ok()
, if the parse was not OK an error message and location is set.- Author:
- John Mayfield
- See Also:
Smarts.parseToResult(org.openscience.cdk.interfaces.IAtomContainer, String)
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
displayErrorLocation()
String
displayErrorLocation(int pos)
Displays where the error occurred on the input string.int
getAtomLocation(int idx)
int
getBondLocation(int idx)
String
getMessage()
The error/warning message.int
getPosition()
The position (string index) in the input that was interpreted.boolean
ok()
Was the SMARTS parsed ok.
-
-
-
Method Detail
-
getMessage
public String getMessage()
The error/warning message.- Returns:
- the message
-
getAtomLocation
public int getAtomLocation(int idx)
-
getBondLocation
public int getBondLocation(int idx)
-
displayErrorLocation
public String displayErrorLocation()
-
displayErrorLocation
public String displayErrorLocation(int pos)
Displays where the error occurred on the input string.- Returns:
- the error location
-
ok
public boolean ok()
Was the SMARTS parsed ok.- Returns:
- parse was OK.
-
getPosition
public int getPosition()
The position (string index) in the input that was interpreted.- Returns:
- the position
-
-