org.xmlcml.cml
Interface AbstractBuiltinContainer 
- All Superinterfaces:
- AbstractBase, AttributeConvention, AttributeDictRef, AttributeId, AttributeTitle, BuiltinContainer, org.w3c.dom.Element, org.w3c.dom.Node
- All Known Subinterfaces:
- AbstractAtom, AbstractBond, CMLAtom, CMLAtomArray, CMLBond, CMLBondArray, CMLCrystal, CMLFormula
- public interface AbstractBuiltinContainer
- extends AbstractBase, BuiltinContainer
supports methods for getting and setting builtin child
values.
|
Field Summary |
static boolean |
NONUNIQUE
|
static int |
STEREO_2D
calculate atom/bond stereo from 2D information; can be added to 3D if both/either to be used |
static int |
STEREO_3D
calculate atom/bond stereo from 3D information; can be added to 2D if both/either to be used |
static int |
STEREO_ANY
calculate atom/bond stereo from either 2D or 3D information |
static boolean |
UNIQUE
|
| Fields inherited from interface org.xmlcml.cml.AbstractBase |
ANGLE, ATOM, ATOMARRAY, ATOMPARITY, BOND, BONDARRAY, BONDSTEREO, BUILTIN, CML, CML_PREFIX, CRYSTAL, ELECTRON, ELEMENT_COUNT, ELEMENT_NAMES, EXECUTE, FEATURE, FLOAT, FLOAT_TYPE, FLOATARRAY, FLOATMATRIX, FORMULA, INTEGER, INTEGER_TYPE, INTEGERARRAY, LINK, LIST, MOLECULE, NAMESPACE_URI, PACKAGE_NAME, REACTION, SEQUENCE, STRING, STRING_TYPE, STRINGARRAY, TORSION, UNK, UNK_ELEM, UNKNOWN |
| Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
|
Method Summary |
CMLFloatVal |
addBuiltinChildWithFloatValue(int builtinType,
java.lang.String[] builtinNames,
double value,
boolean unique,
boolean ignoreExisting)
|
CMLIntegerVal |
addBuiltinChildWithIntegerValue(int builtinType,
java.lang.String[] builtinNames,
int value,
boolean unique,
boolean ignoreExisting)
|
CMLStringVal |
addBuiltinChildWithStringValue(int builtinType,
java.lang.String[] builtinNames,
java.lang.String value,
boolean unique,
boolean ignoreExisting)
add a child with the given value. |
boolean |
checkBuiltins(java.lang.String[] builtinFloatValNames,
java.lang.String[] builtinIntegerValNames,
java.lang.String[] builtinStringValNames)
|
void |
deleteNonBuiltinVal(java.lang.String name)
|
org.w3c.dom.Element |
getBuiltinChild(int builtinType,
java.lang.String[] builtinNames,
int type)
gets the SINGLE child with the given builtin |
java.util.Vector |
getBuiltinChildElements()
extracts all children with builtin attribute; if none empty Vector |
double |
getBuiltinChildFloatValue(int builtinType,
java.lang.String[] builtinNames)
|
int |
getBuiltinChildIntegerValue(int builtinType,
java.lang.String[] builtinNames)
|
java.lang.String |
getBuiltinChildStringValue(int builtinType,
java.lang.String[] builtinNames)
returns the value of a SINGLE child with given builtin |
int |
getBuiltinCount()
|
CMLStringVal |
getBuiltinVal(int builtinId)
|
CMLStringVal |
getNonBuiltinVal(java.lang.String name)
|
void |
removeBuiltinChild(AbstractBase child)
remove a builtin child. |
CMLFloatVal |
setBuiltinFloatChild(int builtinType,
java.lang.String[] builtinNames,
double value)
|
CMLIntegerVal |
setBuiltinIntegerChild(int builtinType,
java.lang.String[] builtinNames,
int value)
|
CMLStringVal |
setBuiltinStringChild(int builtinType,
java.lang.String[] builtinNames,
java.lang.String value)
set the value of the single builtin child, creating if required |
void |
setBuiltinVal(int builtinId,
CMLStringVal value)
|
void |
setNonBuiltinVal(java.lang.String name,
CMLStringVal value)
|
| Methods inherited from interface org.w3c.dom.Element |
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS |
| Methods inherited from interface org.w3c.dom.Node |
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData |
UNIQUE
public static final boolean UNIQUE
- See Also:
- Constant Field Values
NONUNIQUE
public static final boolean NONUNIQUE
- See Also:
- Constant Field Values
STEREO_2D
public static final int STEREO_2D
- calculate atom/bond stereo from 2D information; can be added to 3D if both/either to be used
- See Also:
- Constant Field Values
STEREO_3D
public static final int STEREO_3D
- calculate atom/bond stereo from 3D information; can be added to 2D if both/either to be used
- See Also:
- Constant Field Values
STEREO_ANY
public static final int STEREO_ANY
- calculate atom/bond stereo from either 2D or 3D information
- See Also:
- Constant Field Values
getBuiltinCount
public int getBuiltinCount()
- Specified by:
getBuiltinCount in interface BuiltinContainer
getBuiltinChildElements
public java.util.Vector getBuiltinChildElements()
- extracts all children with builtin attribute; if none empty Vector
getBuiltinVal
public CMLStringVal getBuiltinVal(int builtinId)
- Specified by:
getBuiltinVal in interface BuiltinContainer
setBuiltinVal
public void setBuiltinVal(int builtinId,
CMLStringVal value)
- Specified by:
setBuiltinVal in interface BuiltinContainer
getNonBuiltinVal
public CMLStringVal getNonBuiltinVal(java.lang.String name)
- Specified by:
getNonBuiltinVal in interface BuiltinContainer
setNonBuiltinVal
public void setNonBuiltinVal(java.lang.String name,
CMLStringVal value)
- Specified by:
setNonBuiltinVal in interface BuiltinContainer
deleteNonBuiltinVal
public void deleteNonBuiltinVal(java.lang.String name)
- Specified by:
deleteNonBuiltinVal in interface BuiltinContainer
checkBuiltins
public boolean checkBuiltins(java.lang.String[] builtinFloatValNames,
java.lang.String[] builtinIntegerValNames,
java.lang.String[] builtinStringValNames)
removeBuiltinChild
public void removeBuiltinChild(AbstractBase child)
throws CMLException
- remove a builtin child. throws Exception if it is not a child
getBuiltinChild
public org.w3c.dom.Element getBuiltinChild(int builtinType,
java.lang.String[] builtinNames,
int type)
throws CMLException
- gets the SINGLE child with the given builtin
getBuiltinChildStringValue
public java.lang.String getBuiltinChildStringValue(int builtinType,
java.lang.String[] builtinNames)
throws CMLException
- returns the value of a SINGLE child with given builtin
getBuiltinChildIntegerValue
public int getBuiltinChildIntegerValue(int builtinType,
java.lang.String[] builtinNames)
throws CMLException
getBuiltinChildFloatValue
public double getBuiltinChildFloatValue(int builtinType,
java.lang.String[] builtinNames)
throws CMLException
setBuiltinStringChild
public CMLStringVal setBuiltinStringChild(int builtinType,
java.lang.String[] builtinNames,
java.lang.String value)
throws CMLException
- set the value of the single builtin child, creating if required
setBuiltinIntegerChild
public CMLIntegerVal setBuiltinIntegerChild(int builtinType,
java.lang.String[] builtinNames,
int value)
throws CMLException
setBuiltinFloatChild
public CMLFloatVal setBuiltinFloatChild(int builtinType,
java.lang.String[] builtinNames,
double value)
throws CMLException
addBuiltinChildWithStringValue
public CMLStringVal addBuiltinChildWithStringValue(int builtinType,
java.lang.String[] builtinNames,
java.lang.String value,
boolean unique,
boolean ignoreExisting)
throws CMLException
- add a child with the given value. More options still required
addBuiltinChildWithIntegerValue
public CMLIntegerVal addBuiltinChildWithIntegerValue(int builtinType,
java.lang.String[] builtinNames,
int value,
boolean unique,
boolean ignoreExisting)
throws CMLException
addBuiltinChildWithFloatValue
public CMLFloatVal addBuiltinChildWithFloatValue(int builtinType,
java.lang.String[] builtinNames,
double value,
boolean unique,
boolean ignoreExisting)
throws CMLException
JAVADOC |