Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.xmlcml.cml
Interface CMLAtomArray  view CMLAtomArray download CMLAtomArray.java

All Superinterfaces:
AbstractAtom, AbstractBase, AbstractBuiltinContainer, AttributeConvention, AttributeCount, AttributeDictRef, AttributeId, AttributeTitle, BuiltinArrayContainer, BuiltinContainer, org.w3c.dom.Element, org.w3c.dom.Node

public interface CMLAtomArray
extends AbstractAtom, BuiltinArrayContainer

DTD Class
this interface is only used if AtomArrays are stored as such in the DOM . It may become obsolete since atomArray is only a syntactic container


Field Summary
 
Fields inherited from interface org.xmlcml.cml.AbstractAtom
ATOM_BUILTIN_COUNT, ATOM_FLOATVAL_COUNT, ATOM_FLOATVAL_END, ATOM_FLOATVAL_START, ATOM_ID, ATOM_INTEGERVAL_COUNT, ATOM_INTEGERVAL_END, ATOM_INTEGERVAL_START, ATOM_PARITY_FLOAT, ATOM_PARITY_INT, ATOM_STRINGVAL_COUNT, ATOM_STRINGVAL_END, ATOM_STRINGVAL_START, ATOMID_NAME, builtinFloatValNames, builtinIntegerValNames, builtinStringValNames, ELEMENT_TYPE, ELTYPE_NAME, FCHARGE_NAME, FORMAL_CHARGE_FLOAT, FORMAL_CHARGE_INT, HCOUNT_NAME, HYDROGEN_COUNT_FLOAT, HYDROGEN_COUNT_INT, ISOTOPE_FLOAT, ISOTOPE_INT, ISOTOPE_NAME, NON_HYDROGEN_COUNT_FLOAT, NON_HYDROGEN_COUNT_INT, NONH_NAME, OCC_NAME, OCCUPANCY, PARITY_NAME, RESID_NAME, RESIDUE_ID, RESIDUE_TYPE, RESTYPE_NAME, SMILESATOMS, SP, SP2, SP3, spTypeStrings, valences, X2, X2_NAME, X3, X3_NAME, XFRACT, XFRACT_NAME, Y2, Y2_NAME, Y3, Y3_NAME, YFRACT, YFRACT_NAME, Z3, Z3_NAME, ZFRACT, ZFRACT_NAME
 
Fields inherited from interface org.xmlcml.cml.AbstractBuiltinContainer
NONUNIQUE, STEREO_2D, STEREO_3D, STEREO_ANY, 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
 
Fields inherited from interface org.xmlcml.cml.AttributeTitle
TITLE
 
Fields inherited from interface org.xmlcml.cml.AttributeDictRef
DICTREF
 
Fields inherited from interface org.xmlcml.cml.AttributeId
ID
 
Fields inherited from interface org.xmlcml.cml.AttributeConvention
CONVENTION
 
Fields inherited from interface org.xmlcml.cml.AttributeCount
COUNT
 
Method Summary
 void add(CMLAtom atom)
          when an CMLAtom is added then it is split over the various StringArrays
 AbstractBuiltinContainer createArrayElement(org.w3c.dom.Document document)
           
 void delete(CMLAtom atom)
           
 void deleteNonBuiltinArray(java.lang.String name)
           
 CMLAtom elementAt(int index)
          when an CMLAtom is extracted then it is combined from the various StringArrays
 CMLStringArray getBuiltinArray(int builtinId)
          this is slightly tricky/ucky since CMLAtomArray is subclassed from CMLAtom and CMLStringArray from CMLStringVal we can extract the array object as scalars and simply cast them
 CMLStringArray getNonBuiltinArray(java.lang.String name)
           
 void setBuiltinArray(int builtinId, CMLStringArray array)
           
 void setNonBuiltinArray(java.lang.String name, CMLStringArray array)
           
 int size()
           
 
Methods inherited from interface org.xmlcml.cml.AbstractBuiltinContainer
addBuiltinChildWithFloatValue, addBuiltinChildWithIntegerValue, addBuiltinChildWithStringValue, checkBuiltins, deleteNonBuiltinVal, getBuiltinChild, getBuiltinChildElements, getBuiltinChildFloatValue, getBuiltinChildIntegerValue, getBuiltinChildStringValue, getBuiltinCount, getBuiltinVal, getNonBuiltinVal, removeBuiltinChild, setBuiltinFloatChild, setBuiltinIntegerChild, setBuiltinStringChild, setBuiltinVal, setNonBuiltinVal
 
Methods inherited from interface org.xmlcml.cml.AbstractBase
addTracer, debug, debug, getDisplay, processDOM, readXMLTest, removeTracer, setDOMNeedsProcessing, setDOMNeedsUpdating, updateDOM
 
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
 
Methods inherited from interface org.xmlcml.cml.AttributeTitle
getTitle, processDOMHasTitle, setTitle, updateDOMHasTitle
 
Methods inherited from interface org.xmlcml.cml.AttributeDictRef
getDictRef, processDOMHasDictRef, setDictRef, updateDOMHasDictRef
 
Methods inherited from interface org.xmlcml.cml.AttributeId
getId, processDOMHasId, setId, updateDOMHasId
 
Methods inherited from interface org.xmlcml.cml.AttributeConvention
getConventionName, processDOMHasConvention, setConventionName, updateDOMHasConvention
 
Methods inherited from interface org.xmlcml.cml.AttributeCount
getCount, processDOMHasCount, setCount, updateDOMHasCount
 

Method Detail

add

public void add(CMLAtom atom)
when an CMLAtom is added then it is split over the various StringArrays


size

public int size()

elementAt

public CMLAtom elementAt(int index)
when an CMLAtom is extracted then it is combined from the various StringArrays


delete

public void delete(CMLAtom atom)

getBuiltinArray

public CMLStringArray getBuiltinArray(int builtinId)
this is slightly tricky/ucky since CMLAtomArray is subclassed from CMLAtom and CMLStringArray from CMLStringVal we can extract the array object as scalars and simply cast them

Specified by:
getBuiltinArray in interface BuiltinArrayContainer

setBuiltinArray

public void setBuiltinArray(int builtinId,
                            CMLStringArray array)
Specified by:
setBuiltinArray in interface BuiltinArrayContainer

getNonBuiltinArray

public CMLStringArray getNonBuiltinArray(java.lang.String name)
Specified by:
getNonBuiltinArray in interface BuiltinArrayContainer

setNonBuiltinArray

public void setNonBuiltinArray(java.lang.String name,
                               CMLStringArray array)
Specified by:
setNonBuiltinArray in interface BuiltinArrayContainer

deleteNonBuiltinArray

public void deleteNonBuiltinArray(java.lang.String name)
Specified by:
deleteNonBuiltinArray in interface BuiltinArrayContainer

createArrayElement

public AbstractBuiltinContainer createArrayElement(org.w3c.dom.Document document)
Specified by:
createArrayElement in interface BuiltinArrayContainer