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

Quick Search    Search Deep

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

All Superinterfaces:
AttributeConvention, AttributeDictRef, AttributeId, AttributeTitle, org.w3c.dom.Element, org.w3c.dom.Node
All Known Subinterfaces:
AbstractAngle, AbstractAtom, AbstractAtomRef, AbstractBond, AbstractBuiltinContainer, AbstractNumericVal, AbstractStringVal, CML, CMLAngle, CMLAtom, CMLAtomArray, CMLAtomParity, CMLBond, CMLBondArray, CMLBondStereo, CMLCrystal, CMLElectron, CMLFeature, CMLFloatArray, CMLFloatMatrix, CMLFloatVal, CMLFormula, CMLIntegerArray, CMLIntegerVal, CMLLink, CMLList, CMLMolecule, CMLReaction, CMLSequence, CMLStringArray, CMLStringVal, CMLTorsion

public interface AbstractBase
extends org.w3c.dom.Element, AttributeTitle, AttributeDictRef, AttributeId, AttributeConvention

The base class for all elementObjects mentioned in the CML DTD.

Any CML element may have attributes:

and convenience get/set methods are provided for all, through the interfaces AttributeTitle, AttributeId and AttributeConvention.

An element (FOO) subclassed from a AbstractBase may be constructed in the following ways:


Field Summary
static int ANGLE
           
static int ATOM
           
static int ATOMARRAY
           
static int ATOMPARITY
           
static int BOND
           
static int BONDARRAY
           
static int BONDSTEREO
           
static java.lang.String BUILTIN
          "builtin" attribute name
static int CML
           
static java.lang.String CML_PREFIX
           
static int CRYSTAL
           
static int ELECTRON
           
static int ELEMENT_COUNT
           
static java.lang.String[] ELEMENT_NAMES
           
static int EXECUTE
           
static int FEATURE
           
static int FLOAT
           
static int FLOAT_TYPE
           
static int FLOATARRAY
           
static int FLOATMATRIX
           
static int FORMULA
           
static int INTEGER
           
static int INTEGER_TYPE
           
static int INTEGERARRAY
           
static int LINK
           
static int LIST
           
static int MOLECULE
           
static java.lang.String NAMESPACE_URI
           
static java.lang.String PACKAGE_NAME
           
static int REACTION
           
static int SEQUENCE
           
static int STRING
           
static int STRING_TYPE
           
static int STRINGARRAY
           
static int TORSION
           
static int UNK
           
static int UNK_ELEM
           
static int 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
 
Method Summary
 void addTracer(java.lang.Class theClass)
          set a trace for objects of a class.
 void debug()
          output debug info to System.out
 void debug(java.io.Writer w)
          output debug info to Writer and return String equivalent (e.g.
 java.awt.Component getDisplay()
          a graphical display for this object
 boolean processDOM()
          lazy implementations
 void readXMLTest()
          tests an element that has been read from an XML document.
 void removeTracer(java.lang.Class theClass)
          remove a trace.for objects of a class
 void setDOMNeedsProcessing(boolean processMe)
           
 void setDOMNeedsUpdating(boolean processMe)
           
 boolean 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
 

Field Detail

PACKAGE_NAME

public static final java.lang.String PACKAGE_NAME
See Also:
Constant Field Values

NAMESPACE_URI

public static final java.lang.String NAMESPACE_URI
See Also:
Constant Field Values

CML_PREFIX

public static final java.lang.String CML_PREFIX
See Also:
Constant Field Values

UNK_ELEM

public static final int UNK_ELEM
See Also:
Constant Field Values

ELEMENT_NAMES

public static final java.lang.String[] ELEMENT_NAMES

UNK

public static final int UNK
See Also:
Constant Field Values

ANGLE

public static final int ANGLE
See Also:
Constant Field Values

ATOM

public static final int ATOM
See Also:
Constant Field Values

ATOMARRAY

public static final int ATOMARRAY
See Also:
Constant Field Values

BOND

public static final int BOND
See Also:
Constant Field Values

BONDARRAY

public static final int BONDARRAY
See Also:
Constant Field Values

CML

public static final int CML
See Also:
Constant Field Values

CRYSTAL

public static final int CRYSTAL
See Also:
Constant Field Values

ELECTRON

public static final int ELECTRON
See Also:
Constant Field Values

EXECUTE

public static final int EXECUTE
See Also:
Constant Field Values

FEATURE

public static final int FEATURE
See Also:
Constant Field Values

FLOAT

public static final int FLOAT
See Also:
Constant Field Values

FLOATARRAY

public static final int FLOATARRAY
See Also:
Constant Field Values

FLOATMATRIX

public static final int FLOATMATRIX
See Also:
Constant Field Values

FORMULA

public static final int FORMULA
See Also:
Constant Field Values

INTEGER

public static final int INTEGER
See Also:
Constant Field Values

INTEGERARRAY

public static final int INTEGERARRAY
See Also:
Constant Field Values

LINK

public static final int LINK
See Also:
Constant Field Values

LIST

public static final int LIST
See Also:
Constant Field Values

MOLECULE

public static final int MOLECULE
See Also:
Constant Field Values

REACTION

public static final int REACTION
See Also:
Constant Field Values

SEQUENCE

public static final int SEQUENCE
See Also:
Constant Field Values

STRING

public static final int STRING
See Also:
Constant Field Values

STRINGARRAY

public static final int STRINGARRAY
See Also:
Constant Field Values

TORSION

public static final int TORSION
See Also:
Constant Field Values

ATOMPARITY

public static final int ATOMPARITY
See Also:
Constant Field Values

BONDSTEREO

public static final int BONDSTEREO
See Also:
Constant Field Values

ELEMENT_COUNT

public static final int ELEMENT_COUNT
See Also:
Constant Field Values

BUILTIN

public static final java.lang.String BUILTIN
"builtin" attribute name

See Also:
Constant Field Values

UNKNOWN

public static final int UNKNOWN
See Also:
Constant Field Values

STRING_TYPE

public static final int STRING_TYPE
See Also:
Constant Field Values

FLOAT_TYPE

public static final int FLOAT_TYPE
See Also:
Constant Field Values

INTEGER_TYPE

public static final int INTEGER_TYPE
See Also:
Constant Field Values
Method Detail

processDOM

public boolean processDOM()
                   throws CMLException
lazy implementations


setDOMNeedsProcessing

public void setDOMNeedsProcessing(boolean processMe)

updateDOM

public boolean updateDOM()
                  throws CMLException

setDOMNeedsUpdating

public void setDOMNeedsUpdating(boolean processMe)

readXMLTest

public void readXMLTest()
                 throws CMLException
tests an element that has been read from an XML document. This may be overridden in some or all subclasses


debug

public void debug(java.io.Writer w)
           throws java.io.IOException
output debug info to Writer and return String equivalent (e.g. with new StringWriter(). Can be used for normal XML output


debug

public void debug()
output debug info to System.out


addTracer

public void addTracer(java.lang.Class theClass)
set a trace for objects of a class.


removeTracer

public void removeTracer(java.lang.Class theClass)
remove a trace.for objects of a class


getDisplay

public java.awt.Component getDisplay()
a graphical display for this object