org.xmlcml.stml

Class STMLArray

java.lang.Object

nu.xom.Node

nu.xom.ParentNode

nu.xom.Element

org.xmlcml.stml.STMLElement

org.xmlcml.stml.STMLArray

All Implemented Interfaces:

EuclidConstants, HasArraySize, HasDataType, HasDelimiter, HasDictRef, HasUnits, XMLConstants

public class STMLArray
extends STMLElement
implements HasUnits, HasArraySize, HasDataType, HasDictRef, HasDelimiter

user-modifiable class supporting array. * 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
STMLArray() constructor.
STMLArray(boolean[] array) formed from components.
STMLArray(org.joda.time.DateTime[] array) formed from components.
STMLArray(double[] array) formed from components.
STMLArray(double[] array, String delimiter) formed from components.
STMLArray(int[] array) formed from components.
STMLArray(int[] array, String delimiter) formed from components.
STMLArray(RealArray array) formed from components.
STMLArray(STMLArray old) constructor.
STMLArray(String dataType) creates array of given dataType
STMLArray(String[] array) formed from components.
STMLArray(String[] array, String delimiter) formed from components.

Method Summary

Modifier and Type	Method and Description
void	append(boolean b) add a double.
void	append(org.joda.time.DateTime d) add an integer.
void	append(double d) add a double.
void	append(HasDictRef hasDictRef)
void	append(int i) add an integer.
void	append(STMLArray array)
void	append(STMLScalar scalar)
void	append(String s) add a string.
void	checkNumericConformability(STMLArray array) can two arrays be used for arithmetic.
nu.xom.Element	copy() copy node .
static void	copyAttributesFromTo(nu.xom.Element from, nu.xom.Element to)
static STMLArray	createArray(List<STMLScalar> scalarList)
static STMLArray	createArrayWithAttributes(HasDataType hasDataType)
STMLArray	createEmptyArray(STMLScalar scalar) creates array of type comptatible with scalar can be used to add subsequently scalar contents to array does NOT add scalar contents typical use:
STMLArray	createSubArray(int start, int end) creates a new array formed from a subset of the current array
void	ensureDelimiterAttribute(DelimiterAttribute.Action action)
static List<STMLArray>	extractArrays(List<nu.xom.Element> elements) makes a list of STMLArrays
int	getArraySize() get size of array.
boolean[]	getBooleans() get doubles.
String	getDataType() get dataType.
STMLAttribute	getDataTypeAttribute() The data type of the object.
org.joda.time.DateTime[]	getDates() get dates
String	getDelimiter() reset null to whitespace, etc.
String	getDictRef() null
STMLAttribute	getDictRefAttribute() null
double[]	getDoubles() get doubles.
STMLScalar	getElementAt(int i)
int[]	getInts() get ints.
double[]	getNumbersAsDoubles() convenience method returns a list of doubles for either xsd:integer or xsd:double
Object	getPrimitiveArray() returns array of primitive types based on dataType.
int	getSize() gets size of array.
String[]	getStrings() get strings.
List<String>	getStringValues() returns the String value of the array.
String	getUnits() null
String	getXMLContent() gets value of element;
STMLArray	plus(STMLArray array) add an array to this..
void	removeWhitespaceDelimiterAttribute() removes attributes of the form delimiter="" or delimiter=" "
static void	removeWhitespaceDelimiterAttribute(HasDelimiter hasDelimiter)
void	setArray(boolean[] array) sets components.
void	setArray(org.joda.time.DateTime[] array) sets components.
void	setArray(double[] array) sets components.
void	setArray(int[] array) sets components.
void	setArray(String[] array) sets components.
void	setDataType(String dType) set dataType.
void	setDelimiter(String value) set delimiter.
void	setDictRef(String dictRef) null
void	setSize(int s) Deprecated. not user-accesible - throws STMLRuntime sets delimiter. Cannot reset after array is populated if delimiter is whitespace, removes the attribute
void	setUnits(String prefix, String id, String namespaceURI) sets units attribute.
void	setXMLContent(String content) sets value of element;
STMLArray	subtract(STMLArray array) subtract an array from this..

Methods inherited from class org.xmlcml.stml.STMLElement

addRemove, addSTMLXAttribute, appendChild, copyAttributesFrom, copyChildrenFrom, copyChildrenFromTo, createSubclassedChildren, debug, debug, debug, debug, deleteAttribute, detach, getConstantToSI, getConstantToSIAttribute, getConvention, getConventionAttribute, getDelimiterAttribute, getId, getIdAttribute, getNamespaceURIForPrefix, getSizeAttribute, getSTMLAttributeValue, getSTMLXAttribute, getStringContent, getTool, getUnitsAttribute, insertChild, makeSTMLXAttribute, readAndCreateSTML, readAndCreateSTML, readAndCreateSTML, removeAttribute, replaceChild, serialize, setLocalName, setSize, setSTMLXAttribute, setStringContent, setTool, 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.HasDelimiter

getDelimiterAttribute

Field Detail

TAG

public static final String TAG

See Also:

Constant Field Values

Constructor Detail

STMLArray

public STMLArray()

constructor.

STMLArray

public STMLArray(STMLArray old)

constructor.

Parameters:

old -

STMLArray

public STMLArray(String[] array)
          throws RuntimeException

formed from components. size is extracted from array dimensions sets dataType to xsd:string cannot use default delimiter (S_SPACE) if strings contain whitespace, so choose another delimiter

Parameters:

array -

Throws:

RuntimeException - strings must not contain whitespace

STMLArray

public STMLArray(String[] array,
                 String delimiter)
          throws RuntimeException

formed from components. size is extracted from array dimensions sets dataType to xsd:string cannot use delimiter if strings contain it, so choose another delimiter

Parameters:

array -

delimiter -

Throws:

RuntimeException - strings must not contain delimiter

STMLArray

public STMLArray(RealArray array)

formed from components. size is extracted from array dimensions sets dataType to xsd:double

Parameters:

array -

STMLArray

public STMLArray(double[] array)

formed from components. size is extracted from array dimensions sets dataType to xsd:double

Parameters:

array -

STMLArray

public STMLArray(boolean[] array)

formed from components. size is extracted from array dimensions sets dataType to xsd:double

Parameters:

array -

STMLArray

public STMLArray(double[] array,
                 String delimiter)
          throws RuntimeException

formed from components. size is extracted from array dimensions sets dataType to xsd:double cannot use delimiter if strings contain it, so choose another delimiter

Parameters:

array -

delimiter -

Throws:

RuntimeException - strings must not contain delimiter

STMLArray

public STMLArray(org.joda.time.DateTime[] array)

formed from components. size is extracted from array dimensions sets dataType to xsd:integer

Parameters:

array -

STMLArray

public STMLArray(int[] array)

formed from components. size is extracted from array dimensions sets dataType to xsd:integer

Parameters:

array -

STMLArray

public STMLArray(int[] array,
                 String delimiter)

formed from components. size is extracted from array dimensions sets dataType to xsd:integer cannot use delimiter if strings contain it, so choose another delimiter

Parameters:

array -

delimiter -

STMLArray

public STMLArray(String dataType)

creates array of given dataType

Parameters:

dataType -

Method Detail

copy

public nu.xom.Element copy()

copy node .

Overrides:

copy in class STMLElement

Returns:

Node

createArray

public static STMLArray createArray(List<STMLScalar> scalarList)

createArrayWithAttributes

public static STMLArray createArrayWithAttributes(HasDataType hasDataType)

createEmptyArray

public STMLArray createEmptyArray(STMLScalar scalar)

creates array of type comptatible with scalar can be used to add subsequently scalar contents to array does NOT add scalar contents typical use:

 List<STMLScalar> scalars; STMLArray array =
 STMLArray.createEmptyArray(scalars.get(0)); for (STMLScalar scalar :
 scalars) { array.append(scalar); }
 

Parameters:

scalar -

Returns:

createSubArray

public STMLArray createSubArray(int start,
                                int end)
                         throws IllegalArgumentException

creates a new array formed from a subset of the current array

Parameters:

start - inclusive start

end - inclusive end

Returns:

new array of correct dataType and dictRef; null if fails

Throws:

IllegalArgumentException - if indices are out of bounds

getArraySize

public int getArraySize()

get size of array.

Specified by:

getArraySize in interface HasArraySize

Returns:

size

getPrimitiveArray

public Object getPrimitiveArray()

returns array of primitive types based on dataType.

Returns:

double[], int[], String[] or null

getStrings

public String[] getStrings()

get strings.

Returns:

strings

getBooleans

public boolean[] getBooleans()
                      throws RuntimeException

get doubles.

Returns:

doubles

Throws:

RuntimeException

getDoubles

public double[] getDoubles()
                    throws RuntimeException

get doubles.

Specified by:

getDoubles in interface HasArraySize

Returns:

doubles

Throws:

RuntimeException

getNumbersAsDoubles

public double[] getNumbersAsDoubles()

convenience method returns a list of doubles for either xsd:integer or xsd:double

Returns:

getDates

public org.joda.time.DateTime[] getDates()
                                  throws RuntimeException

get dates

Returns:

dates

Throws:

RuntimeException

getInts

public int[] getInts()
              throws RuntimeException

get ints.

Specified by:

getInts in interface HasArraySize

Returns:

ints

Throws:

RuntimeException

getElementAt

public STMLScalar getElementAt(int i)

copyAttributesFromTo

public static void copyAttributesFromTo(nu.xom.Element from,
                                        nu.xom.Element to)

getStringValues

public List<String> getStringValues()

returns the String value of the array. convenience method to avoid repeated accesses i.e. converts int and double to string

Specified by:

getStringValues in interface HasArraySize

Returns:

strings

setArray

public void setArray(String[] array)
              throws RuntimeException

sets components.

Parameters:

array -

Throws:

RuntimeException

setArray

public void setArray(org.joda.time.DateTime[] array)

sets components. NOT IMPLEMENTED

Parameters:

array -

setArray

public void setArray(boolean[] array)

sets components.

Parameters:

array -

setArray

public void setArray(double[] array)

sets components.

Parameters:

array -

setArray

public void setArray(int[] array)

sets components.

Parameters:

array -

getSize

public int getSize()

gets size of array.

Overrides:

getSize in class STMLElement

Returns:

int size of array

getDelimiter

public String getDelimiter()

reset null to whitespace, etc.

Specified by:

getDelimiter in interface HasDelimiter

Overrides:

getDelimiter in class STMLElement

Returns:

String

setDelimiter

public void setDelimiter(String value)

set delimiter.

Specified by:

setDelimiter in interface HasDelimiter

Overrides:

setDelimiter in class STMLElement

Parameters:

value -

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)

setDataType

public void setDataType(String dType)

set dataType. sets dataType. Cannot reset after array is populated

Specified by:

setDataType in interface HasDataType

Overrides:

setDataType in class STMLElement

Parameters:

dType - (default XSD_STRING)

Throws:

RuntimeException - attempt to reset datatype

setSize

public void setSize(int s)

Deprecated. not user-accesible - throws STMLRuntime sets delimiter. Cannot reset after array is populated if delimiter is whitespace, removes the attribute

set size.

Overrides:

setSize in class STMLElement

Parameters:

s - the size

Throws:

RuntimeException - attempt to reset datatype

checkNumericConformability

public void checkNumericConformability(STMLArray array)

can two arrays be used for arithmetic. checks that both arrays are numeric and of same dataType and of same size

Parameters:

array - the array to test; can have different owner

subtract

public STMLArray subtract(STMLArray array)

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

Parameters:

array - the array to subtract; can have different owner

Returns:

new array

plus

public STMLArray plus(STMLArray array)

add an array to this.. result is this + array, owner document = this does not alter this only works if both arrays are numeric and of same dataType

Parameters:

array - the array to add; can have different owner

Returns:

the new array

append

public void append(String s)
            throws RuntimeException

add a string. datatype must be unset or have been set to XSD_STRING

Parameters:

s - String to add

Throws:

RuntimeException - dataType not XSD_STRING

append

public void append(boolean b)
            throws RuntimeException

add a double. datatype must have been set to XSD_DOUBLE

Parameters:

b -

Throws:

RuntimeException - dataType not XSD_DOUBLE

append

public void append(double d)
            throws RuntimeException

add a double. datatype must have been set to XSD_DOUBLE

Parameters:

d - double to add

Throws:

RuntimeException - dataType not XSD_DOUBLE

append

public void append(int i)
            throws RuntimeException

add an integer. datatype must have been set to XSD_INTEGER

Parameters:

i - integer to add

Throws:

RuntimeException - dataType not XSD_INTEGER

append

public void append(STMLArray array)

append

public void append(STMLScalar scalar)

append

public void append(HasDictRef hasDictRef)

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

append

public void append(org.joda.time.DateTime d)
            throws RuntimeException

add an integer. datatype must have been set to XSD_DATE

Parameters:

d - date to add

Throws:

RuntimeException

removeWhitespaceDelimiterAttribute

public void removeWhitespaceDelimiterAttribute()

removes attributes of the form delimiter="" or delimiter=" "

Specified by:

removeWhitespaceDelimiterAttribute in interface HasDelimiter

removeWhitespaceDelimiterAttribute

public static void removeWhitespaceDelimiterAttribute(HasDelimiter hasDelimiter)

extractArrays

public static List<STMLArray> extractArrays(List<nu.xom.Element> elements)

makes a list of STMLArrays

Parameters:

elements -

Returns:

List<STMLArray>

getDictRefAttribute

public STMLAttribute getDictRefAttribute()

Description copied from class: STMLElement

null

Specified by:

getDictRefAttribute in interface HasDictRef

Overrides:

getDictRefAttribute in class STMLElement

Returns:

STMLAttribute

getDictRef

public String getDictRef()

Description copied from class: STMLElement

null

Specified by:

getDictRef in interface HasDictRef

Overrides:

getDictRef in class STMLElement

Returns:

String

setDictRef

public void setDictRef(String dictRef)

Description copied from class: STMLElement

null

Specified by:

setDictRef in interface HasDictRef

Overrides:

setDictRef in class STMLElement

Parameters:

dictRef - title value

getXMLContent

public String getXMLContent()

Description copied from interface: HasDataType

gets value of element;

Specified by:

getXMLContent in interface HasDataType

Overrides:

getXMLContent in class STMLElement

Returns:

String

setXMLContent

public void setXMLContent(String content)

Description copied from interface: HasDataType

sets value of element;

Specified by:

setXMLContent in interface HasDataType

Overrides:

setXMLContent in class STMLElement

Parameters:

content - title value

getUnits

public String getUnits()

Description copied from class: STMLElement

null

Specified by:

getUnits in interface HasUnits

Overrides:

getUnits in class STMLElement

Returns:

String

ensureDelimiterAttribute

public void ensureDelimiterAttribute(DelimiterAttribute.Action action)

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:

STMLAttribute