org.xmlcml.stml

Class STMLScalar

java.lang.Object

nu.xom.Node

nu.xom.ParentNode

nu.xom.Element

org.xmlcml.stml.STMLElement

org.xmlcml.stml.STMLScalar

All Implemented Interfaces:

EuclidConstants, HasDataType, HasDictRef, HasScalar, HasUnits, XMLConstants

public class STMLScalar
extends STMLElement
implements HasUnits, HasScalar, HasDictRef, HasDataType

user-modifiable class supporting scalar. * autogenerated from schema use as a shell which can be edited

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG

Fields inherited from class org.xmlcml.stml.STMLElement

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

Constructor Summary

Constructors

Constructor and Description
STMLScalar() default constructor.
STMLScalar(Boolean scalar) formed from components.
STMLScalar(org.joda.time.DateTime scalar) formed from components.
STMLScalar(double scalar) formed from components.
STMLScalar(int scalar) formed from components.
STMLScalar(STMLScalar old) constructor.
STMLScalar(String scalar) formed from components.

Method Summary

Modifier and Type	Method and Description
nu.xom.Element	copy() copy node .
Boolean	getBoolean() gets boolean.
String	getDataType() get dataType.
STMLAttribute	getDataTypeAttribute() The data type of the object.
Class<?>	getDataTypeClass() get class.
org.joda.time.DateTime	getDate() gets real value.
DictRefAttribute	getDictRefFromElementOrParent() gets dictRef OR from parent.
double	getDouble() gets real value.
int	getInt() gets int value.
Double	getNumberAsDouble()
String	getString() gets String value.
String	getUnits() null
STMLScalar	plus(STMLScalar scalar) add a scalar to this..
void	plusEquals(STMLScalar scalar) subtract an scalar from this..
void	setDataType(String dType) set dataType.
void	setUnits(String prefix, String id, String namespaceURI) sets units attribute.
void	setValue(Boolean scalar) sets value to boolean..
void	setValue(org.joda.time.DateTime scalar) sets value to date.
void	setValue(double scalar) sets value to double.
void	setValue(int scalar) sets value to int..
void	setValue(String scalar) sets value to String..
void	setValueNoTrim(String scalar) sets value to String..
STMLScalar	subtract(STMLScalar scalar) subtract an scalar from this..
void	subtractEquals(STMLScalar scalar) subtract an scalar from this..

Methods inherited from class org.xmlcml.stml.STMLElement

addRemove, addSTMLXAttribute, appendChild, copyAttributesFrom, copyAttributesFromTo, copyChildrenFrom, copyChildrenFromTo, createSubclassedChildren, debug, debug, debug, debug, deleteAttribute, detach, getConstantToSI, getConstantToSIAttribute, getConvention, getConventionAttribute, getDelimiter, getDelimiterAttribute, getDictRef, getDictRefAttribute, getId, getIdAttribute, getNamespaceURIForPrefix, getSize, getSizeAttribute, getSTMLAttributeValue, getSTMLXAttribute, getStringContent, getTool, getUnitsAttribute, getXMLContent, insertChild, makeSTMLXAttribute, readAndCreateSTML, readAndCreateSTML, readAndCreateSTML, removeAttribute, replaceChild, serialize, setDelimiter, setDictRef, setLocalName, setSize, setSize, setSTMLXAttribute, setStringContent, setTool, setXMLContent, unknownAttributeName, writeHTML

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

Methods inherited from interface org.xmlcml.stml.interfacex.HasDataType

getXMLContent, setXMLContent

Methods inherited from interface org.xmlcml.stml.interfacex.HasDictRef

getDictRef, getDictRefAttribute, setDictRef

Field Detail

TAG

public static final String TAG

See Also:

Constant Field Values

Constructor Detail

STMLScalar

public STMLScalar()

default constructor. NOTE creates a CMLScalar with dataType = XSD_STRING and content CMLConstants.S_EMPTY.

STMLScalar

public STMLScalar(STMLScalar old)

constructor.

Parameters:

old -

STMLScalar

public STMLScalar(Boolean scalar)

formed from components. sets dataType to xsd:boolean

Parameters:

scalar -

STMLScalar

public STMLScalar(org.joda.time.DateTime scalar)

formed from components. sets dataType to xsd:date

Parameters:

scalar -

STMLScalar

public STMLScalar(String scalar)

formed from components. sets dataType to xsd:string

Parameters:

scalar -

STMLScalar

public STMLScalar(double scalar)

formed from components. sets dataType to xsd:double

Parameters:

scalar -

STMLScalar

public STMLScalar(int scalar)

formed from components. sets dataType to xsd:integer

Parameters:

scalar -

Method Detail

copy

public nu.xom.Element copy()

copy node .

Overrides:

copy in class STMLElement

Returns:

Element

getBoolean

public Boolean getBoolean()

gets boolean. dataType must be XSD_BOOLEAN.

Returns:

the value (null if not set)

getDate

public org.joda.time.DateTime getDate()

gets real value. dataType must be XSD_DATE

Returns:

the value (NaN if not set)

getDouble

public double getDouble()

gets real value. dataType must be XSD_DOUBLE.

Specified by:

getDouble in interface HasScalar

Returns:

the value (NaN if not set)

getString

public String getString()

gets String value. dataType must be XSD_STRING.

Specified by:

getString in interface HasScalar

Returns:

the value (null if not set)

getInt

public int getInt()

gets int value. dataType must be XSD_INTEGER.

Specified by:

getInt in interface HasScalar

Returns:

the value

Throws:

RuntimeException - if different type

setValue

public void setValue(Boolean scalar)

sets value to boolean.. updates dataType.

Parameters:

scalar -

setValue

public void setValue(org.joda.time.DateTime scalar)

sets value to date. updates dataType.

Parameters:

scalar -

setValue

public void setValue(String scalar)

sets value to String.. updates dataType. TRIMS value

Parameters:

scalar - no action if null

setValueNoTrim

public void setValueNoTrim(String scalar)

sets value to String.. updates dataType. does NOT trim value or normalize whitespace

Parameters:

scalar - no action if null

setValue

public void setValue(double scalar)

sets value to double. updates dataType.

Parameters:

scalar -

setValue

public void setValue(int scalar)

sets value to int.. updates dataType.

Parameters:

scalar -

getDataType

public String getDataType()

get dataType. if attribute not set, reset to String.

Specified by:

getDataType in interface HasDataType

Overrides:

getDataType in class STMLElement

Returns:

dataType (default XSD_STRING)

getDataTypeClass

public Class<?> getDataTypeClass()

get class. if attribute not set, reset to String.

Returns:

class, default String.class

setDataType

public void setDataType(String dType)

set dataType. this may not be set independently of the value, so simply throws CMLRuntime only place it is usable is within copy constructor

Specified by:

setDataType in interface HasDataType

Overrides:

setDataType in class STMLElement

Parameters:

dType -

Throws:

RuntimeException - attempt to reset datatype

subtract

public STMLScalar subtract(STMLScalar scalar)

subtract an scalar from this.. result = this - scalar, owner document = this does not alter this only works if both scalars are numeric and of same dataType

Parameters:

scalar - the scalar to subtract; can have different owner

Returns:

new scalar

subtractEquals

public void subtractEquals(STMLScalar scalar)

subtract an scalar from this.. this -= scalar, owner document = this alters this only works if both scalars are numeric and of same dataType

Parameters:

scalar - the scalar to subtract; can have different owner

plus

public STMLScalar plus(STMLScalar scalar)

add a scalar to this.. result = this + scalar does not alter this only works if both scalars are numeric and of same dataType

Parameters:

scalar - the scalar to add;

Returns:

new scalar

plusEquals

public void plusEquals(STMLScalar scalar)

subtract an scalar from this.. this += scalar, owner document = this alters this only works if both scalars are numeric and of same dataType

Parameters:

scalar - the scalar to subtract;

getDictRefFromElementOrParent

public DictRefAttribute getDictRefFromElementOrParent()

gets dictRef OR from parent. see DictRefAttribute.getDictRefFromElementOrParent()

Returns:

the attribute or null

setUnits

public void setUnits(String prefix,
                     String id,
                     String namespaceURI)

sets units attribute. requires namespace for unit to be in scope.

Specified by:

setUnits in interface HasUnits

Parameters:

prefix - for namespace

id - for unit

namespaceURI - sets units namespace if not present already

getNumberAsDouble

public Double getNumberAsDouble()

getUnits

public String getUnits()

Description copied from class: STMLElement

null

Specified by:

getUnits in interface HasUnits

Overrides:

getUnits in class STMLElement

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.

Overrides:

getDataTypeAttribute in class STMLElement

Returns:

CMLAttribute