org.xmlcml.stml.STMLScalar Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of euclid Show documentation
Show all versions of euclid Show documentation
A Java library for 2D and 3D geometric calculations
/**
* Copyright 2011 Peter Murray-Rust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.xmlcml.stml;
import java.text.ParseException;
import org.apache.log4j.Logger;
import org.joda.time.DateTime;
import org.xmlcml.euclid.JodaDate;
import org.xmlcml.euclid.Util;
import org.xmlcml.stml.attribute.DictRefAttribute;
import org.xmlcml.stml.attribute.NamespaceRefAttribute;
import org.xmlcml.stml.interfacex.HasDataType;
import org.xmlcml.stml.interfacex.HasDictRef;
import org.xmlcml.stml.interfacex.HasScalar;
import org.xmlcml.stml.interfacex.HasUnits;
import nu.xom.Element;
/**
* user-modifiable class supporting scalar. * autogenerated from schema use as a
* shell which can be edited
*
*/
public class STMLScalar extends STMLElement implements HasUnits, HasScalar, HasDictRef, HasDataType {
@SuppressWarnings("unused")
private static Logger LOG = Logger.getLogger(STMLScalar.class);
public final static String TAG = "scalar";
/**
* default constructor. NOTE creates a CMLScalar with dataType = XSD_STRING
* and content CMLConstants.S_EMPTY.
*
*/
public STMLScalar() {
super(TAG);
init();
}
void init() {
// setXMLContent(S_EMPTY);
}
/**
* constructor.
*
* @param old
*/
public STMLScalar(STMLScalar old) {
super( old);
}
/**
* copy node .
*
* @return Element
*/
public Element copy() {
return new STMLScalar(this);
}
// =========================== additional constructors
// ========================
/**
* formed from components. sets dataType to xsd:boolean
*
* @param scalar
*/
public STMLScalar(Boolean scalar) {
this.setValue(scalar);
}
/**
* formed from components. sets dataType to xsd:date
*
* @param scalar
*/
public STMLScalar(DateTime scalar) {
this.setValue(scalar);
}
/**
* formed from components. sets dataType to xsd:string
*
* @param scalar
*/
public STMLScalar(String scalar) {
this();
this.setValue(scalar);
}
/**
* formed from components. sets dataType to xsd:double
*
* @param scalar
*/
public STMLScalar(double scalar) {
this.setValue(scalar);
}
/**
* formed from components. sets dataType to xsd:integer
*
* @param scalar
*/
public STMLScalar(int scalar) {
this.setValue(scalar);
}
/**
* gets boolean. dataType must be XSD_BOOLEAN.
*
* @return the value (null if not set)
*/
public Boolean getBoolean() {
Boolean result = null;
if (getDataType().equals(XSD_BOOLEAN)) {
String content = getXMLContent();
if (content != null) {
result = Boolean.parseBoolean(content);
}
}
return result;
}
/**
* gets real value. dataType must be XSD_DATE
*
* @return the value (NaN if not set)
*/
public DateTime getDate() {
DateTime result = null;
if (getDataType().equals(XSD_DATE)) {
String content = getXMLContent();
if (content != null) {
try {
result = JodaDate.parseDate(content);
} catch (Exception e) {
throw new RuntimeException("bad date", e);
}
}
}
return result;
}
/**
* gets real value. dataType must be XSD_DOUBLE.
*
* @return the value (NaN if not set)
*/
public double getDouble() {
double result = Double.NaN;
if (getDataType().equals(XSD_DOUBLE)) {
String content = getXMLContent();
if (content != null) {
try {
result = (Util.parseFlexibleDouble(content));
} catch (ParseException e) {
throw new RuntimeException("Bad double :" + content, e);
}
}
}
return result;
}
/**
* gets String value. dataType must be XSD_STRING.
*
* @return the value (null if not set)
*/
public String getString() {
String result = null;
if (getDataType().equals(XSD_STRING)) {
result = getXMLContent();
}
return result;
}
/**
* gets int value. dataType must be XSD_INTEGER.
*
* @return the value
* @throws RuntimeException
* if different type
*/
public int getInt() {
int result = Integer.MIN_VALUE;
if (getDataType().equals(XSD_INTEGER)) {
String content = getXMLContent();
if (content != null && !content.trim().equals(S_EMPTY)) {
try {
result = Integer.parseInt(content);
} catch (NumberFormatException e) {
throw new RuntimeException("bad integer content: "
+ content);
}
}
} else {
throw new RuntimeException("wrong dataType for int "
+ getDataType());
}
return result;
}
// ====================== subsidiary accessors =====================
/**
* sets value to boolean.. updates dataType.
*
* @param scalar
*/
public void setValue(Boolean scalar) {
setXMLContent(S_EMPTY + scalar);
super.setDataType(XSD_BOOLEAN);
}
/**
* sets value to date. updates dataType.
*
* @param scalar
*/
public void setValue(DateTime scalar) {
String date = JodaDate.formatDate(scalar);
setXMLContent(date);
super.setDataType(XSD_DATE);
}
/**
* sets value to String.. updates dataType.
* TRIMS value
* @param scalar no action if null
*/
public void setValue(String scalar) {
if (scalar != null) {
setXMLContent(scalar);
super.setDataType(XSD_STRING);
}
}
/**
* sets value to String.. updates dataType.
* does NOT trim value or normalize whitespace
* @param scalar no action if null
*/
public void setValueNoTrim(String scalar) {
if (scalar != null) {
this.removeChildren();
this.appendChild(scalar);
this.setDataType(XSD_STRING);
}
}
/**
* sets value to double. updates dataType.
*
* @param scalar
*/
public void setValue(double scalar) {
setXMLContent(S_EMPTY + scalar);
super.setDataType(XSD_DOUBLE);
}
/**
* sets value to int.. updates dataType.
*
* @param scalar
*/
public void setValue(int scalar) {
setXMLContent(S_EMPTY + scalar);
super.setDataType(XSD_INTEGER);
}
/**
* get dataType. if attribute not set, reset to String.
*
* @return dataType (default XSD_STRING)
*/
public String getDataType() {
String dataType = super.getDataType();
if (dataType == null) {
dataType = STMLConstants.XSD_STRING;
super.setDataType(dataType);
}
return STMLType.getNormalizedValue(dataType);
}
/**
* get class. if attribute not set, reset to String.
*
* @return class, default String.class
*/
public Class getDataTypeClass() {
Class clazz = null;
String dataType = getDataType();
if (XSD_STRING.equals(dataType)) {
clazz = String.class;
} else if (XSD_DOUBLE.equals(dataType)) {
clazz = Double.class;
} else if (XSD_INTEGER.equals(dataType)) {
clazz = Integer.class;
} else if (XSD_BOOLEAN.equals(dataType)) {
clazz = Boolean.class;
} else if (XSD_DATE.equals(dataType)) {
clazz = DateTime.class;
} else {
}
return clazz;
}
/**
* set dataType. this may not be set independently of the value, so simply
* throws CMLRuntime only place it is usable is within copy constructor
*
* @param dType
* @throws RuntimeException
* attempt to reset datatype
*/
public void setDataType(String dType) {
if (this.getAttributeValue("dataType") == null) {
super.setDataType(dType);
} else {
throw new RuntimeException(
"Must not reset dataType; use SetValue(...)");
}
}
// ====================== functionality =====================
/**
* can two scalars be used for arithmetic. checks that both scalars are
* numeric and of same dataType and of same size
*
* @param scalar
* the scalar to test; can have different owner
* @throws CMLException
* if not of same numeric data type
*/
void checkNumericConformability(STMLScalar scalar) {
if (!this.getDataType().equals(scalar.getDataType())) {
throw new RuntimeException(
"Unsuitable dataTypes for numeric operations / "
+ this.getDataType() + STMLConstants.S_SLASH
+ scalar.getDataType());
}
}
/**
* 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
*
* @param scalar
* the scalar to subtract; can have different owner
* @return new scalar
*/
public STMLScalar subtract(STMLScalar scalar) {
checkNumericConformability(scalar);
STMLScalar resultScalar = null;
if (this.getDataType().equals(XSD_DOUBLE)) {
resultScalar = new STMLScalar(this.getDouble() - scalar.getDouble());
} else if (this.getDataType().equals(XSD_INTEGER)) {
resultScalar = new STMLScalar(this.getInt() - scalar.getInt());
}
return resultScalar;
}
/**
* subtract an scalar from this..
*
* this -= scalar, owner document = this alters this only works if both
* scalars are numeric and of same dataType
*
* @param scalar
* the scalar to subtract; can have different owner
*/
public void subtractEquals(STMLScalar scalar) {
checkNumericConformability(scalar);
if (this.getDataType().equals(XSD_DOUBLE)) {
this.setValue(this.getDouble() - scalar.getDouble());
} else if (this.getDataType().equals(XSD_INTEGER)) {
this.setValue(this.getInt() - scalar.getInt());
}
}
/**
* add a scalar to this..
*
* result = this + scalar does not alter this only works if both scalars are
* numeric and of same dataType
*
* @param scalar
* the scalar to add;
* @return new scalar
*/
public STMLScalar plus(STMLScalar scalar) {
checkNumericConformability(scalar);
STMLScalar resultScalar = null;
if (this.getDataType().equals(XSD_DOUBLE)) {
resultScalar = new STMLScalar(this.getDouble() + scalar.getDouble());
} else if (this.getDataType().equals(XSD_INTEGER)) {
resultScalar = new STMLScalar(this.getInt() + scalar.getInt());
}
return resultScalar;
}
/**
* subtract an scalar from this..
*
* this += scalar, owner document = this alters this only works if both
* scalars are numeric and of same dataType
*
* @param scalar
* the scalar to subtract;
*/
public void plusEquals(STMLScalar scalar) {
checkNumericConformability(scalar);
if (this.getDataType().equals(XSD_DOUBLE)) {
this.setValue(this.getDouble() + scalar.getDouble());
} else if (this.getDataType().equals(XSD_INTEGER)) {
this.setValue(this.getInt() + scalar.getInt());
}
}
/**
* gets dictRef OR from parent. see
* DictRefAttribute.getDictRefFromElementOrParent()
*
* @return the attribute or null
*/
public DictRefAttribute getDictRefFromElementOrParent() {
return DictRefAttribute.getDictRefFromElementOrParent(this);
}
/**
* sets units attribute. requires namespace for unit to be in scope.
*
* @param prefix
* for namespace
* @param id
* for unit
* @param namespaceURI
* sets units namespace if not present already
*/
public void setUnits(String prefix, String id, String namespaceURI) {
NamespaceRefAttribute.setUnits((HasUnits) this, prefix, id,
namespaceURI);
}
public Double getNumberAsDouble() {
Double d = getDouble();
if (d == null || Double.isNaN(d)) {
try {
Integer i = getInt();
d = (double) i;
} catch (Exception e) {
// null
}
}
return d;
}
public String getUnits() {
return getAttributeValue("units");
}
/** The data type of the object.
* Normally applied to scalar/array
* objects but may extend to more complex one.
* @return CMLAttribute
*/
public STMLAttribute getDataTypeAttribute() {
return (STMLAttribute) getAttribute("dataType");
}
}