org.xmlcml.cml
Interface AbstractBuiltinContainer

All Known Subinterfaces:
AbstractAtom, AbstractBond, Atom, AtomArray, Bond, BondArray, Crystal

public interface AbstractBuiltinContainer
extends CMLBase, HasBuiltinNames


Field Summary
static boolean NONUNIQUE
           
static boolean UNIQUE
           
 
Fields inherited from interface org.xmlcml.cml.CMLBase
ANGLE, ATOM, ATOMARRAY, BOND, BONDARRAY, BUILTIN, CML, CRYSTAL, ELECTRON, ELEMENT_COUNT, ELEMENT_NAMES, EXECUTE, FEATURE, FLOAT, FLOAT_TYPE, FLOATARRAY, FLOATMATRIX, FORMULA, INTEGER, INTEGER_TYPE, INTEGERARRAY, LINK, LIST, MOLECULE, PACKAGE_NAME, REACTION, SEQUENCE, STRING, STRING_TYPE, STRINGARRAY, TORSION, UNK, UNK_ELEM, UNKNOWN
 
Fields inherited from interface uk.co.demon.ursus.dom.PMRElement
CLASSNAME, LOCAL, QUALIFIED, UNIVERSAL
 
Fields inherited from interface org.xmlcml.cml.HasTitle
TITLE
 
Fields inherited from interface org.xmlcml.cml.HasDictRef
DICTREF
 
Fields inherited from interface org.xmlcml.cml.HasId
ID
 
Fields inherited from interface org.xmlcml.cml.HasConvention
CONVENTION
 
Fields inherited from interface uk.co.demon.ursus.dom.PMRNode
ATTRIBUTES, CONTENT, ELEMENTNAME, IDLIST, NESTED, NESTEDATTS, PACKAGENAME, PRETTY, SPLITFILES, STYLE, TAGGED, UNTAGGED, WHITESPACE, XMLCONTENT
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Method Summary
 void addBuiltinChildWithFloatValue(int builtinType, java.lang.String[] builtinNames, double value, boolean unique)
           
 void addBuiltinChildWithIntegerValue(int builtinType, java.lang.String[] builtinNames, int value, boolean unique)
           
 void addBuiltinChildWithStringValue(int builtinType, java.lang.String[] builtinNames, java.lang.String value, boolean unique)
          sets the value
 boolean checkBuiltins(java.lang.String[] builtinFloatValNames, java.lang.String[] builtinIntegerValNames, java.lang.String[] builtinStringValNames)
           
 void deleteNonBuiltinVal(java.lang.String name)
           
 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()
           
 StringVal getBuiltinVal(int builtinId)
           
 StringVal getNonBuiltinVal(java.lang.String name)
           
 void setBuiltinVal(int builtinId, StringVal value)
           
 void setNonBuiltinVal(java.lang.String name, StringVal value)
           
 
Methods inherited from interface org.xmlcml.cml.CMLBase
addValidity, debug, isValid, processDOM, updateDOM
 
Methods inherited from interface uk.co.demon.ursus.dom.PMRElement
appendTo, getValidity, processDescendants, setProcessFlag, setTagName
 
Methods inherited from interface org.xmlcml.cml.HasTitle
getTitle, setTitle, updateDOMHasTitle
 
Methods inherited from interface org.xmlcml.cml.HasDictRef
getDictRef, setDictRef, updateDOMHasDictRef
 
Methods inherited from interface org.xmlcml.cml.HasId
getId, setId, updateDOMHasId
 
Methods inherited from interface org.xmlcml.cml.HasConvention
getConventionName, setConventionName, updateDOMHasConvention
 
Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS
 

Field Detail

UNIQUE

public static final boolean UNIQUE

NONUNIQUE

public static final boolean NONUNIQUE
Method Detail

getBuiltinCount

public int getBuiltinCount()
Specified by:
getBuiltinCount in interface HasBuiltinNames

getBuiltinChildElements

public java.util.Vector getBuiltinChildElements()
extracts all children with builtin attribute; if none empty Vector

getBuiltinVal

public StringVal getBuiltinVal(int builtinId)
Specified by:
getBuiltinVal in interface HasBuiltinNames

setBuiltinVal

public void setBuiltinVal(int builtinId,
                          StringVal value)
Specified by:
setBuiltinVal in interface HasBuiltinNames

getNonBuiltinVal

public StringVal getNonBuiltinVal(java.lang.String name)
Specified by:
getNonBuiltinVal in interface HasBuiltinNames

setNonBuiltinVal

public void setNonBuiltinVal(java.lang.String name,
                             StringVal value)
Specified by:
setNonBuiltinVal in interface HasBuiltinNames

deleteNonBuiltinVal

public void deleteNonBuiltinVal(java.lang.String name)
Specified by:
deleteNonBuiltinVal in interface HasBuiltinNames

checkBuiltins

public boolean checkBuiltins(java.lang.String[] builtinFloatValNames,
                             java.lang.String[] builtinIntegerValNames,
                             java.lang.String[] builtinStringValNames)

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

addBuiltinChildWithStringValue

public void addBuiltinChildWithStringValue(int builtinType,
                                           java.lang.String[] builtinNames,
                                           java.lang.String value,
                                           boolean unique)
                                    throws CMLException
sets the value

addBuiltinChildWithIntegerValue

public void addBuiltinChildWithIntegerValue(int builtinType,
                                            java.lang.String[] builtinNames,
                                            int value,
                                            boolean unique)
                                     throws CMLException

addBuiltinChildWithFloatValue

public void addBuiltinChildWithFloatValue(int builtinType,
                                          java.lang.String[] builtinNames,
                                          double value,
                                          boolean unique)
                                   throws CMLException