/* Copyright 2010 - 2014 by Brian Uri!
This file is part of DDMSence.
This library is free software; you can redistribute it and/or modify
it under the terms of version 3.0 of the GNU Lesser General Public
License as published by the Free Software Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with DDMSence. If not, see <http://www.gnu.org/licenses/>.
You can contact the author at ddmsence@urizone.net. The DDMSence
home page is located at http://ddmsence.urizone.net/
*/
package buri.ddmsence;
import java.io.Serializable;
import com.google.gson.JsonObject;
import nu.xom.Element;
import buri.ddmsence.ddms.IBuilder;
import buri.ddmsence.ddms.ITspiShape;
import buri.ddmsence.ddms.InvalidDDMSException;
import buri.ddmsence.ddms.OutputFormat;
import buri.ddmsence.ddms.summary.gml.SRSAttributes;
import buri.ddmsence.util.Util;
/**
* Base class for TSPI shapes.
* <br /><br />
* {@ddms.versions 00001}
*
* <p> Extensions of this class are generally expected to be immutable, and the underlying XOM element MUST be set
* before the component is used. </p>
*
* <p>For the initial support of DDMS 5.0 TSPI shapes, the DDMSence component will only return the raw XML of
* a shape. The TSPI specification is incredibly complex and multi-layered, and it is unclear how much
* value full-fledged classes would have. As use cases refine and more organizations adopt DDMS 5.0, the components
* can be revisited to provide more value-add.</p>
*
* {@table.header History}
* None.
* {@table.footer}
* {@table.header Nested Elements}
* None.
* {@table.footer}
* {@table.header Attributes}
* {@child.info gml:id|1|00001}
* {@child.info <<i>srsAttributes</i>>|0..*|00001}
* {@table.footer}
* {@table.header Validation Rules}
* {@ddms.rule Component must not be used before the DDMS version in which it was introduced.|Error|11111}
* {@ddms.rule The srsName must exist.|Error|11111}
* {@ddms.rule The gml:id must exist, and must be a valid NCName.|Error|11111}
* {@ddms.rule If the gml:pos has an srsName, it must match the srsName of this Point.|Error|11111}
* {@ddms.rule Warnings from any SRS attributes are claimed by this component.|Warning|11111}
* <p>No additional validation is done on the TSPI shape at this time.</p>
* {@table.footer}
*
* @author Brian Uri!
* @since 2.2.0
*/
public abstract class AbstractTspiShape extends AbstractBaseComponent implements ITspiShape {
private SRSAttributes _srsAttributes = null;
private static final String ID_NAME = "id";
/**
* Base constructor which works from a XOM element.
*
* @param element the XOM element
*/
protected AbstractTspiShape(Element element) throws InvalidDDMSException {
try {
setXOMElement(element, false);
_srsAttributes = new SRSAttributes(element);
validate();
}
catch (InvalidDDMSException e) {
e.setLocator(getQualifiedName());
throw (e);
}
}
/**
* @see AbstractBaseComponent#validate()
*/
protected void validate() throws InvalidDDMSException {
requireAtLeastVersion("5.0");
Util.requireDDMSValue("srsAttributes", getSRSAttributes());
Util.requireDDMSValue("srsName", getSRSAttributes().getSrsName());
Util.requireDDMSValue(ID_NAME, getId());
Util.requireValidNCName(getId());
super.validate();
}
/**
* @see AbstractBaseComponent#getJSONObject()
*/
public JsonObject getJSONObject() {
JsonObject object = new JsonObject();
addJson(object, "shapeType", Util.decapitalize(getName()));
return (object);
}
/**
* @see AbstractBaseComponent#getHTMLTextOutput(OutputFormat, String, String)
*/
public String getHTMLTextOutput(OutputFormat format, String prefix, String suffix) {
Util.requireHTMLText(format);
String localPrefix = buildPrefix(prefix, "", suffix);
StringBuffer text = new StringBuffer();
text.append(buildHTMLTextOutput(format, localPrefix + "shapeType", Util.decapitalize(getName())));
return (text.toString());
}
/**
* @see Object#equals(Object)
*/
public boolean equals(Object obj) {
if (!super.equals(obj))
return (false);
AbstractTspiShape test = (AbstractTspiShape) obj;
return (toXML().equals(test.toXML()));
// ID and SRSAttributes are implicit in the XML.
}
/**
* @see Object#hashCode()
*/
public int hashCode() {
int result = super.hashCode();
result = 7 * result + toXML().hashCode();
// ID and SRSAttributes are implicit in the XML.
return (result);
}
/**
* Accessor for the ID
*/
public String getId() {
return (getAttributeValue(ID_NAME, getDDMSVersion().getGmlNamespace()));
}
/**
* Accessor for the SRS Attributes. Will always be non-null.
*/
public SRSAttributes getSRSAttributes() {
return (_srsAttributes);
}
/**
* Abstract Builder for this DDMS component.
*
* <p>Builders which are based upon this abstract class should implement the commit() method, returning the
* appropriate concrete object type.</p>
*
* @see IBuilder
* @author Brian Uri!
* @since 2.2.0
*/
public static abstract class Builder implements IBuilder, Serializable {
private static final long serialVersionUID = 7824644958681123708L;
private String _xml;
/**
* Empty constructor
*/
protected Builder() {}
/**
* Constructor which starts from an existing component.
*/
protected Builder(AbstractTspiShape address) {
setXml(address.toXML());
}
/**
* Commits the XML string to a XOM element
*
* @throws InvalidDDMSException if the XML cannot be converted.
*/
protected Element commitXml() throws InvalidDDMSException {
return (Util.commitXml(getXml()));
}
/**
* @see IBuilder#isEmpty()
*/
public boolean isEmpty() {
return (Util.isEmpty(getXml()));
}
/**
* Builder accessor for the XML string representing the element.
*/
public String getXml() {
return _xml;
}
/**
* Builder accessor for the XML string representing the element.
*/
public void setXml(String xml) {
_xml = xml;
}
}
}