org.xmlcml.stml

Class STMLAttribute

java.lang.Object

nu.xom.Node

nu.xom.Attribute

org.xmlcml.stml.STMLAttribute

All Implemented Interfaces:

EuclidConstants, XMLConstants

Direct Known Subclasses:

DoubleArraySTAttribute, DoubleSTAttribute, IntArraySTAttribute, IntSTAttribute, StringArraySTAttribute, StringSTAttribute

public class STMLAttribute
extends nu.xom.Attribute
implements XMLConstants

generic subclassed Attribute for CML elements. often further subclassed into strongly typed attributes in CMLSchema an attributeGroup normally wraps the attribute. Normally the names are the same, but sometimes the attribute group has a different name from the attribute. In some cases two different attributes can have the same name but different attribute groups. The attributeGroup name is only used for collecting the attributes

Version:

5.0

Author:

Peter Murray-Rust

Nested Class Summary

Nested classes/interfaces inherited from class nu.xom.Attribute

nu.xom.Attribute.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attributeGroupName
protected STMLType	cmlType
static String	CONSTANT_TO_SI
static String	CONVENTION
protected String	description
static String	DICTREF
static String	ID
static String	MULTIPLIER_TO_SI
protected String	summary
static String	TITLE
static String	UNITS

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

Modifier	Constructor and Description
	STMLAttribute(nu.xom.Attribute att) semi copy constructor
protected	STMLAttribute(nu.xom.Attribute att, String value) copy constructor from empty attribute.
	STMLAttribute(STMLAttribute att) copy constructor
	STMLAttribute(String name) creates attribute without value.
	STMLAttribute(String name, String value) creates attribute.
protected	STMLAttribute(String name, String URI, String value) creates attribute.

Method Summary

Modifier and Type	Method and Description
int	compareTo(nu.xom.Attribute att) compares attributes.
nu.xom.Attribute	copy() makes copy of correct class.
String	getAttributeGroupName() gets attributeGroup name.
STMLType	getCmlType()
String	getDescription() get Documentation.
String	getJavaGetMethod() get Java get method.
String	getJavaSetMethod() get Java set method default
String	getJavaShortClassName() get Java ShortClassName.
String	getJavaType() get JavaType default
STMLType	getSchemaType() get schema type.
Object	getSTMLValue() returns value as a typed object.
String	getSummary() get documentation summary.
void	setAttributeGroupName(String agn) sets attributeGroup name.
void	setCmlType(STMLType cmlType)
void	setDescription(String d) set Documentation.
void	setSchemaType(STMLType schemaType) set schema type.
void	setSTMLValue(String s) sets value.
void	setSummary(String s) set documentation summary.

Methods inherited from class nu.xom.Attribute

getChild, getChildCount, getLocalName, getNamespacePrefix, getNamespaceURI, getQualifiedName, getType, getValue, setLocalName, setNamespace, setType, setValue, toString, toXML

Methods inherited from class nu.xom.Node

detach, equals, getBaseURI, getDocument, getParent, hashCode, query, query

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONSTANT_TO_SI

public static final String CONSTANT_TO_SI

See Also:

Constant Field Values

CONVENTION

public static final String CONVENTION

See Also:

Constant Field Values

DICTREF

public static final String DICTREF

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

MULTIPLIER_TO_SI

public static final String MULTIPLIER_TO_SI

See Also:

Constant Field Values

TITLE

public static final String TITLE

See Also:

Constant Field Values

UNITS

public static final String UNITS

See Also:

Constant Field Values

cmlType

protected STMLType cmlType

summary

protected String summary

description

protected String description

attributeGroupName

protected String attributeGroupName

Constructor Detail

STMLAttribute

public STMLAttribute(String name)

creates attribute without value. do not use directly

Parameters:

name -

STMLAttribute

public STMLAttribute(String name,
                     String value)

creates attribute.

Parameters:

name -

value -

STMLAttribute

protected STMLAttribute(String name,
                        String URI,
                        String value)
                 throws nu.xom.NamespaceConflictException

creates attribute.

Parameters:

name - must be qualified (colonized)

URI - namespace

value -

Throws:

nu.xom.NamespaceConflictException - probably no prefix in name

STMLAttribute

public STMLAttribute(STMLAttribute att)

copy constructor

Parameters:

att -

STMLAttribute

public STMLAttribute(nu.xom.Attribute att)

semi copy constructor

Parameters:

att -

STMLAttribute

protected STMLAttribute(nu.xom.Attribute att,
                        String value)

copy constructor from empty attribute. used to create subclasses

Parameters:

att - to copy

value - to add (may throw CMLRuntime)

Method Detail

copy

public nu.xom.Attribute copy()

makes copy of correct class. shallow copy as most fields are not mutable

Overrides:

copy in class nu.xom.Attribute

Returns:

copy of node

setAttributeGroupName

public void setAttributeGroupName(String agn)

sets attributeGroup name. normally only useful when generating code when the attributeGroup name may be different from the attribute name. it is required for lookup

Parameters:

agn - attributeGroup name

getAttributeGroupName

public String getAttributeGroupName()

gets attributeGroup name. normally only useful when generating code when the attributeGroup name may be different from the attribute name. it is required for lookup

Returns:

attributeGroup name

compareTo

public int compareTo(nu.xom.Attribute att)

compares attributes. As we cannot override Node.equals() which compares identity we have to compare components. order of sorting is: attribute class cmlType name name value null values of any component return -1

Parameters:

att - to compare

Returns:

0 if all content is identical, -1 if this less than att, 1 if greater value

getJavaType

public String getJavaType()

get JavaType default

Returns:

"String"

getJavaSetMethod

public String getJavaSetMethod()

get Java set method default

Returns:

"setSTMLValue"

getJavaGetMethod

public String getJavaGetMethod()

get Java get method.

Returns:

"getSTMLValue"

getJavaShortClassName

public String getJavaShortClassName()

get Java ShortClassName.

Returns:

"STMLAttribute"

getSchemaType

public STMLType getSchemaType()

get schema type.

Returns:

"STMLAttribute"

setSchemaType

public void setSchemaType(STMLType schemaType)

set schema type.

Parameters:

schemaType - could be null

getSTMLValue

public Object getSTMLValue()

returns value as a typed object. if object is a primitive, return in wrapper (e.g. Integer) object might be an array of primitives (e.g. int[]) types are: String, String[], Integer, int[], Double, double[]

Returns:

the value

setSTMLValue

public void setSTMLValue(String s)

sets value. often subclassed which will throw exception if of wrong type

Parameters:

s - the value

getSummary

public String getSummary()

get documentation summary.

Returns:

the summary

setSummary

public void setSummary(String s)

set documentation summary.

Parameters:

s - the summary

getDescription

public String getDescription()

get Documentation.

Returns:

the description

setDescription

public void setDescription(String d)

set Documentation.

Parameters:

d - the description

getCmlType

public STMLType getCmlType()

Returns:

the cmlType

setCmlType

public void setCmlType(STMLType cmlType)

Parameters:

cmlType - the cmlType to set