STMLElement (CML Euclid 2.9 API)

java.lang.Object
- nu.xom.Node
- - nu.xom.ParentNode
  - - nu.xom.Element
    - - org.xmlcml.stml.STMLElement

All Implemented Interfaces:

EuclidConstants, XMLConstants

Direct Known Subclasses:

STMLArray, STMLScalar
```
public class STMLElement
extends nu.xom.Element
implements XMLConstants
```
base class for all STML elements can be sorted on id attribute

Version:

5.0

Author:

Peter Murray-Rust

Field Summary

Fields
Modifier and Type Field and Description

protected static AttributeFactory attributeFactory
- Fields inherited from interface org.xmlcml.xml.XMLConstants
  ATTRIBUTES, AUTOGENERATED_DONOTEDIT_S, BANNER_S, CATALOG_XML, CML_SIUNITS, CML_UNITS, ELEMENTS, FPX_REAL, JAVA_ARRAY, JAVA_BOOL, JAVA_BOOLEAN, JAVA_DOUB, JAVA_DOUBLE, JAVA_INT, JAVA_INTEGER, JAVA_STRING, PATTERN_ANYURI, PATTERN_QNAME, SVG_NS, SVG_NS_BASE, SVG_XPATH, TYPES, U_ANGSTROM, U_CELSIUS, U_DEGREE, U_KCAL, WARNING_S, X_OR, XHTML_NS, XLINK_NS, XLINK_PREFIX, XML_SUFF, XMLNS, XPATH_XSD, XSD_ANNOTATION, XSD_ANYURI, XSD_ATTRIBUTE, XSD_ATTRIBUTE_GROUP, XSD_BOOLEAN, XSD_COMPLEX_TYPE, XSD_DATE, XSD_DOCUMENTATION, XSD_DOUBLE, XSD_ELEMENT, XSD_ENUMERATION, XSD_EXTENSION, XSD_FLOAT, XSD_INTEGER, XSD_LENGTH, XSD_LIST, XSD_MAXEXCLUSIVE, XSD_MAXINCLUSIVE, XSD_MINEXCLUSIVE, XSD_MININCLUSIVE, XSD_NONNEGATIVEINTEGER, XSD_NS, XSD_PATTERN, XSD_POSITIVE_NUMBER, XSD_POSITIVEINTEGER, XSD_PREFIX, XSD_QNAME, XSD_RESTRICTION, XSD_SIMPLE_CONTENT, XSD_SIMPLE_TYPE, XSD_STRING, XSD_SUFF, XSD_UNION, XSD_XMLNS
- Fields inherited from interface org.xmlcml.euclid.EuclidConstants
  C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Fields
Modifier and Type	Field and Description
`protected static AttributeFactory`	`attributeFactory`

Constructor Summary

Constructors
Modifier Constructor and Description

protected STMLElement()

STMLElement(STMLElement element)
copy constructor.

STMLElement(String name)
main constructor.

Constructors
Modifier	Constructor and Description
`protected`	`STMLElement()`
	`STMLElement(STMLElement element)` copy constructor.
	`STMLElement(String name)` main constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addRemove(STMLAttribute att, String value)`
`static void`	`addSTMLXAttribute(nu.xom.Element element, String attName, String attValue)` creates a prefixed STMLX attribute (cmlx:foo="bar") on element in STMLX namespace
`void`	`appendChild(nu.xom.Node child)` Appends a node to the children of this node.
`nu.xom.Element`	`copy()` copy node.
`void`	`copyAttributesFrom(nu.xom.Element element)` copies attributes.
`static void`	`copyAttributesFromTo(nu.xom.Element from, nu.xom.Element to)` copy attributes from one STMLElement to another.
`void`	`copyChildrenFrom(nu.xom.Element element)` copies children of element make subclasses when required
`static void`	`copyChildrenFromTo(nu.xom.Element element, nu.xom.Element to)` copies children of element make subclasses when required
`protected static void`	`createSubclassedChildren(nu.xom.Element oldElement, STMLElement newElement)`
`void`	`debug()` debug for element.
`void`	`debug(int indent)` debug for element.
`void`	`debug(OutputStream os, int indent)` debug.
`void`	`debug(String message)` debug for element.
`static void`	`deleteAttribute(nu.xom.Element element, String attName)` it attribute exists detach it.
`void`	`detach()` re-route detach().
`double`	`getConstantToSI()` Additive constant to generate SI equivalent.
`STMLAttribute`	`getConstantToSIAttribute()` Additive constant to generate SI equivalent.
`String`	`getConvention()` A reference to a convention.
`STMLAttribute`	`getConventionAttribute()` A reference to a convention.
`String`	`getDataType()` The data type of the object.
`STMLAttribute`	`getDataTypeAttribute()` The data type of the object.
`String`	`getDelimiter()` null
`STMLAttribute`	`getDelimiterAttribute()` null
`String`	`getDictRef()` null
`STMLAttribute`	`getDictRefAttribute()` null
`String`	`getId()` null
`STMLAttribute`	`getIdAttribute()` null
`String`	`getNamespaceURIForPrefix(String prefix)` get namespace.
`int`	`getSize()` The size of an array or matrix.
`STMLAttribute`	`getSizeAttribute()` The size of an array or matrix.
`protected String`	`getSTMLAttributeValue(String name)`
`String`	`getSTMLXAttribute(String attName)` convenience method to get value of cmlx:foo attribute.
`String`	`getStringContent()` gets String content.
`AbstractSTMTool`	`getTool()`
`String`	`getUnits()` null
`STMLAttribute`	`getUnitsAttribute()` null
`String`	`getXMLContent()`
`void`	`insertChild(nu.xom.Node newNode, int pos)` override insertChild.
`static nu.xom.Attribute`	`makeSTMLXAttribute(String attName, String value)` convenience method to create new cmlx:foo attribute.
`static STMLElement`	`readAndCreateSTML(nu.xom.Element element)`
`static STMLElement`	`readAndCreateSTML(File file)` converts a SVG file to SVGElement
`static STMLElement`	`readAndCreateSTML(InputStream is)` converts a SVG file to SVGElement
`void`	`removeAttribute(String attName)` remove attribute.
`void`	`replaceChild(nu.xom.Node oldNode, nu.xom.Node newNode)` override replaceChild.
`void`	`serialize(OutputStream os, int indent)` convenience method to serialize the element.
`void`	`setDataType(String type)`
`void`	`setDelimiter(String value)` null
`void`	`setDictRef(String value)` null
`void`	`setLocalName(String localName)` override setLocalName(localName) to make it immutable.
`void`	`setSize(int value)` The size of an array or matrix.
`void`	`setSize(String value)` The size of an array or matrix.
`void`	`setSTMLXAttribute(String attName, String attValue)` convenience method to add cmlx:foo attributes.
`void`	`setStringContent(String value)` sets String content.
`void`	`setTool(AbstractSTMTool tool)`
`void`	`setXMLContent(String value)`
`protected void`	`unknownAttributeName(String name)` throws Exception.
`void`	`writeHTML(Writer w)` write as HTML.

Methods inherited from class nu.xom.Element
addAttribute, addNamespaceDeclaration, appendChild, getAttribute, getAttribute, getAttribute, getAttributeCount, getAttributeValue, getAttributeValue, getBaseURI, getChildElements, getChildElements, getChildElements, getFirstChildElement, getFirstChildElement, getLocalName, getNamespaceDeclarationCount, getNamespacePrefix, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getQualifiedName, getValue, insertChild, removeAttribute, removeChildren, removeNamespaceDeclaration, setBaseURI, setNamespacePrefix, setNamespaceURI, shallowCopy, toString, toXML

Methods inherited from class nu.xom.ParentNode
getChild, getChildCount, indexOf, removeChild, removeChild

Methods inherited from class nu.xom.Node
equals, getDocument, getParent, hashCode, query, query

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - attributeFactory
```
protected static AttributeFactory attributeFactory
```
- Constructor Detail
  - STMLElement
```
protected STMLElement()
```
  - STMLElement
```
public STMLElement(String name)
```
    main constructor.
    
    Parameters:
    
    name - tagname
  - STMLElement
```
public STMLElement(STMLElement element)
```
    copy constructor. copies attributes, children and properties using the copyFoo() routines (q.v.)
    
    Parameters:
    
    element -
- Method Detail
  - readAndCreateSTML
```
public static STMLElement readAndCreateSTML(nu.xom.Element element)
```
  - readAndCreateSTML
```
public static STMLElement readAndCreateSTML(File file)
```
    converts a SVG file to SVGElement
    
    Parameters:
    
    file -
    
    Returns:
  - readAndCreateSTML
```
public static STMLElement readAndCreateSTML(InputStream is)
```
    converts a SVG file to SVGElement
    
    Parameters:
    
    is -
    
    Returns:
  - createSubclassedChildren
```
protected static void createSubclassedChildren(nu.xom.Element oldElement,
                                               STMLElement newElement)
```
  - copy
```
public nu.xom.Element copy()
```
    copy node.
    
    Overrides:
    
    copy in class nu.xom.Element
    
    Returns:
    
    node
  - copyAttributesFrom
```
public void copyAttributesFrom(nu.xom.Element element)
```
    copies attributes. makes subclass if necessary.
    
    Parameters:
    
    element - to copy from
  - copyChildrenFrom
```
public void copyChildrenFrom(nu.xom.Element element)
```
    copies children of element make subclasses when required
    
    Parameters:
    
    element - to copy from
  - copyChildrenFromTo
```
public static void copyChildrenFromTo(nu.xom.Element element,
                                      nu.xom.Element to)
```
    copies children of element make subclasses when required
    
    Parameters:
    
    element - to copy from
    
    to -
  - replaceChild
```
public void replaceChild(nu.xom.Node oldNode,
                         nu.xom.Node newNode)
```
    override replaceChild.
    
    Overrides:
    
    replaceChild in class nu.xom.ParentNode
    
    Parameters:
    
    oldNode -
    
    newNode -
  - insertChild
```
public void insertChild(nu.xom.Node newNode,
                        int pos)
```
    override insertChild. if newNode has parent detach()es first
    
    Overrides:
    
    insertChild in class nu.xom.ParentNode
    
    Parameters:
    
    newNode -
    
    pos -
  - detach
```
public void detach()
```
    re-route detach(). to parent.removeChild(this);
    
    Overrides:
    
    detach in class nu.xom.Node
  - setLocalName
```
public void setLocalName(String localName)
```
    override setLocalName(localName) to make it immutable. if localname is null sets it, else no-op
    
    Overrides:
    
    setLocalName in class nu.xom.Element
    
    Parameters:
    
    localName -
  - unknownAttributeName
```
protected void unknownAttributeName(String name)
```
    throws Exception.
    
    Parameters:
    
    name - of attribute
  - getSTMLAttributeValue
```
protected String getSTMLAttributeValue(String name)
```
  - removeAttribute
```
public void removeAttribute(String attName)
```
    remove attribute.
    
    Parameters:
    
    attName -
  - copyAttributesFromTo
```
public static void copyAttributesFromTo(nu.xom.Element from,
                                        nu.xom.Element to)
```
    copy attributes from one STMLElement to another. overwrites existing atts
    
    Parameters:
    
    from - element to copy from
    
    to - element to copy to
  - deleteAttribute
```
public static void deleteAttribute(nu.xom.Element element,
                                   String attName)
```
    it attribute exists detach it.
    
    Parameters:
    
    element -
    
    attName -
  - debug
```
public void debug(String message)
```
    debug for element. makes copy if not document root writes to sysout
    
    Parameters:
    
    message -
  - debug
```
public void debug()
```
    debug for element. makes copy if not document root writes to sysout
  - debug
```
public void debug(int indent)
```
    debug for element. makes copy if not docuemnt root writes to sysout
    
    Parameters:
    
    indent -
  - debug
```
public void debug(OutputStream os,
                  int indent)
           throws IOException
```
    debug.
    
    Parameters:
    
    os -
    
    indent -
    
    Throws:
    
    IOException
  - getStringContent
```
public String getStringContent()
```
    gets String content. only valid when there is a single Text child. not checked against the schema, so use with care
    
    Returns:
    
    the XML text content or null
  - setStringContent
```
public void setStringContent(String value)
```
    sets String content. very FRAGILE. not checked against the schema, so use with care. It is almost always better to use the accessors generated from the schema
    
    Parameters:
    
    value - the XML text content
  - writeHTML
```
public void writeHTML(Writer w)
               throws IOException
```
    write as HTML. many elements will override this method.
    
    Parameters:
    
    w - writer
    
    Throws:
    
    IOException
  - serialize
```
public void serialize(OutputStream os,
                      int indent)
               throws IOException
```
    convenience method to serialize the element.
    
    Parameters:
    
    os -
    
    indent - to indent lines by (non-zero may muck up whitespace)
    
    Throws:
    
    IOException
  - setSTMLXAttribute
```
public void setSTMLXAttribute(String attName,
                              String attValue)
```
    convenience method to add cmlx:foo attributes.
    
    Parameters:
    
    attName - WITHOUT prefix
    
    attValue - if null removes any old attributes
  - addSTMLXAttribute
```
public static void addSTMLXAttribute(nu.xom.Element element,
                                     String attName,
                                     String attValue)
```
    creates a prefixed STMLX attribute (cmlx:foo="bar") on element in STMLX namespace
    
    Parameters:
    
    element -
    
    attName - UNPREFIXED
    
    attValue -
  - makeSTMLXAttribute
```
public static nu.xom.Attribute makeSTMLXAttribute(String attName,
                                                  String value)
```
    convenience method to create new cmlx:foo attribute.
    
    Parameters:
    
    attName - WITHOUT prefix and colon
    
    value - if null undefined
    
    Returns:
  - getSTMLXAttribute
```
public String getSTMLXAttribute(String attName)
```
    convenience method to get value of cmlx:foo attribute.
    
    Parameters:
    
    attName - WITHOUT prefix
  - appendChild
```
public void appendChild(nu.xom.Node child)
```
    Appends a node to the children of this node.
    
    Overrides:
    
    appendChild in class nu.xom.ParentNode
    
    Parameters:
    
    child - node to append to this node
    
    Throws:
    
    nu.xom.IllegalAddException - if this node cannot have children of this type
    
    NullPointerException - if child is null
  - getTool
```
public AbstractSTMTool getTool()
```
    Returns:
    
    the tool
  - setTool
```
public void setTool(AbstractSTMTool tool)
```
    Parameters:
    
    tool - the tool to set
  - setDataType
```
public void setDataType(String type)
```
  - getNamespaceURIForPrefix
```
public String getNamespaceURIForPrefix(String prefix)
```
    get namespace.
    
    Parameters:
    
    prefix -
    
    Returns:
    
    namespace
  - getDataType
```
public String getDataType()
```
    The data type of the object. Normally applied to scalar/array objects but may extend to more complex one.
    
    Returns:
    
    String
  - getDataTypeAttribute
```
public STMLAttribute getDataTypeAttribute()
```
    The data type of the object. Normally applied to scalar/array objects but may extend to more complex one.
    
    Returns:
    
    STMLAttribute
  - getDelimiter
```
public String getDelimiter()
```
    null
    
    Returns:
    
    String
  - getDelimiterAttribute
```
public STMLAttribute getDelimiterAttribute()
```
    null
    
    Returns:
    
    STMLAttribute
  - getDictRef
```
public String getDictRef()
```
    null
    
    Returns:
    
    String
  - setDictRef
```
public void setDictRef(String value)
                throws RuntimeException
```
    null
    
    Parameters:
    
    value - title value
    
    Throws:
    
    RuntimeException - attribute wrong value/type
  - getDictRefAttribute
```
public STMLAttribute getDictRefAttribute()
```
    null
    
    Returns:
    
    STMLAttribute
  - addRemove
```
protected void addRemove(STMLAttribute att,
                         String value)
```
  - getConstantToSI
```
public double getConstantToSI()
```
    Additive constant to generate SI equivalent. The amount to add to a quantity in non-SI units to convert its representation to SI Units. This is applied *after* multiplierToSI. It is necessarily zero for SI units.
    
    Returns:
    
    double
  - getConstantToSIAttribute
```
public STMLAttribute getConstantToSIAttribute()
```
    Additive constant to generate SI equivalent. The amount to add to a quantity in non-SI units to convert its representation to SI Units. This is applied *after* multiplierToSI. It is necessarily zero for SI units.
    
    Returns:
    
    STMLAttribute
  - getConvention
```
public String getConvention()
```
    A reference to a convention. There is no controlled vocabulary for conventions, but the author must ensure that the semantics are openly available and that there are mechanisms for implementation. The convention is inherited by all the subelements, so that a convention for molecule would by default extend to its bond and atom children. This can be overwritten if necessary by an explicit convention. It may be useful to create conventions with namespaces (e.g. iupac:name). Use of convention will normally require non-STMML semantics, and should be used with caution. We would expect that conventions prefixed with "ISO" would be useful, such as ISO8601 for dateTimes. There is no default, but the conventions of STMML or the related language (e.g. STML) will be assumed.
    
    Returns:
    
    String
  - getConventionAttribute
```
public STMLAttribute getConventionAttribute()
```
    A reference to a convention. There is no controlled vocabulary for conventions, but the author must ensure that the semantics are openly available and that there are mechanisms for implementation. The convention is inherited by all the subelements, so that a convention for molecule would by default extend to its bond and atom children. This can be overwritten if necessary by an explicit convention. It may be useful to create conventions with namespaces (e.g. iupac:name). Use of convention will normally require non-STMML semantics, and should be used with caution. We would expect that conventions prefixed with "ISO" would be useful, such as ISO8601 for dateTimes. There is no default, but the conventions of STMML or the related language (e.g. STML) will be assumed.
    
    Returns:
    
    STMLAttribute
  - getId
```
public String getId()
```
    null
    
    Returns:
    
    String
  - getIdAttribute
```
public STMLAttribute getIdAttribute()
```
    null
    
    Returns:
    
    STMLAttribute
  - getUnits
```
public String getUnits()
```
    null
    
    Returns:
    
    String
  - getUnitsAttribute
```
public STMLAttribute getUnitsAttribute()
```
    null
    
    Returns:
    
    STMLAttribute
  - getSize
```
public int getSize()
```
    The size of an array or matrix. No description
    
    Returns:
    
    int
  - getSizeAttribute
```
public STMLAttribute getSizeAttribute()
```
    The size of an array or matrix. No description
    
    Returns:
    
    STMLAttribute
  - setDelimiter
```
public void setDelimiter(String value)
                  throws RuntimeException
```
    null
    
    Parameters:
    
    value - title value
    
    Throws:
    
    RuntimeException - attribute wrong value/type
  - setSize
```
public void setSize(int value)
             throws RuntimeException
```
    The size of an array or matrix. No description
    
    Parameters:
    
    value - title value
    
    Throws:
    
    RuntimeException - attribute wrong value/type
  - setSize
```
public void setSize(String value)
             throws RuntimeException
```
    The size of an array or matrix. No description
    
    Parameters:
    
    value - title value
    
    Throws:
    
    RuntimeException - attribute wrong value/type
  - setXMLContent
```
public void setXMLContent(String value)
                   throws RuntimeException
```
    Parameters:
    
    value - title value
    
    Throws:
    
    RuntimeException - attribute wrong value/type
  - getXMLContent
```
public String getXMLContent()
```
    Returns:
    
    String

Class STMLElement

Field Summary

Fields inherited from interface org.xmlcml.xml.XMLConstants

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class nu.xom.Element

Methods inherited from class nu.xom.ParentNode

Methods inherited from class nu.xom.Node

Methods inherited from class java.lang.Object

Field Detail

attributeFactory

Constructor Detail

STMLElement

STMLElement

STMLElement

Method Detail

readAndCreateSTML

readAndCreateSTML

readAndCreateSTML

createSubclassedChildren

copy

copyAttributesFrom

copyChildrenFrom

copyChildrenFromTo

replaceChild

insertChild

detach

setLocalName

unknownAttributeName

getSTMLAttributeValue

removeAttribute

copyAttributesFromTo

deleteAttribute

debug

debug

debug

debug

getStringContent

setStringContent

writeHTML

serialize

setSTMLXAttribute

addSTMLXAttribute

makeSTMLXAttribute

getSTMLXAttribute

appendChild

getTool

setTool

setDataType

getNamespaceURIForPrefix

getDataType

getDataTypeAttribute

getDelimiter

getDelimiterAttribute

getDictRef

setDictRef

getDictRefAttribute

addRemove

getConstantToSI

getConstantToSIAttribute

getConvention

getConventionAttribute

getId

getIdAttribute

getUnits

getUnitsAttribute

getSize

getSizeAttribute

setDelimiter

setSize

setSize

setXMLContent

getXMLContent