Java tutorial
/* 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.ddms.resource; import java.io.Serializable; import java.util.ArrayList; import java.util.List; import nu.xom.Element; import buri.ddmsence.AbstractBaseComponent; import buri.ddmsence.AbstractProducerRole; import buri.ddmsence.ddms.IBuilder; import buri.ddmsence.ddms.IDDMSComponent; import buri.ddmsence.ddms.InvalidDDMSException; import buri.ddmsence.ddms.OutputFormat; import buri.ddmsence.util.DDMSVersion; import buri.ddmsence.util.Util; import com.google.gson.JsonObject; /** * An immutable implementation of ddms:recordKeeper. * <br /><br /> * {@ddms.versions 00011} * * <p></p> * * {@table.header History} * None. * {@table.footer} * {@table.header Nested Elements} * {@child.info ddms:recordKeeperID|1|00011} * {@child.info ddms:organization|1|00011} * {@table.footer} * {@table.header Attributes} * None. * {@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 qualified name of this element must be correct.|Error|11111} * {@ddms.rule ddms:recordKeeperID must exist.|Error|11111} * {@ddms.rule ddms:organization must exist.|Error|11111} * {@table.footer} * * @author Brian Uri! * @since 2.0.0 */ public class RecordKeeper extends AbstractBaseComponent { private Organization _organization = null; private static final String RECORD_KEEPER_ID_NAME = "recordKeeperID"; /** * Constructor for creating a component from a XOM Element * * @param element the XOM element representing this * @throws InvalidDDMSException if any required information is missing or malformed */ public RecordKeeper(Element element) throws InvalidDDMSException { try { Util.requireDDMSValue("element", element); if (element.getChildElements().size() > 1) { Element organizationElement = element.getChildElements().get(1); if (organizationElement != null) _organization = new Organization(organizationElement); } setXOMElement(element, true); } catch (InvalidDDMSException e) { e.setLocator(getQualifiedName()); throw (e); } } /** * Constructor which builds from raw data. * * @param recordKeeperID a unique ID for the organization * @param organization the organization acting as record keeper */ public RecordKeeper(String recordKeeperID, Organization organization) throws InvalidDDMSException { try { Element element = Util.buildDDMSElement(RecordKeeper.getName(DDMSVersion.getCurrentVersion()), null); if (!Util.isEmpty(recordKeeperID)) element.appendChild(Util.buildDDMSElement(RECORD_KEEPER_ID_NAME, recordKeeperID)); if (organization != null) element.appendChild(organization.getXOMElementCopy()); _organization = organization; setXOMElement(element, true); } catch (InvalidDDMSException e) { e.setLocator(getQualifiedName()); throw (e); } } /** * @see AbstractProducerRole#validate() */ protected void validate() throws InvalidDDMSException { requireAtLeastVersion("4.0.1"); Util.requireDDMSQName(getXOMElement(), RecordKeeper.getName(getDDMSVersion())); Util.requireDDMSValue("record keeper ID", getRecordKeeperID()); Util.requireDDMSValue("organization", getOrganization()); super.validate(); } /** * @see Object#equals(Object) */ public boolean equals(Object obj) { if (!super.equals(obj) || !(obj instanceof RecordKeeper)) return (false); RecordKeeper test = (RecordKeeper) obj; return (getRecordKeeperID().equals(test.getRecordKeeperID())); } /** * @see Object#hashCode() */ public int hashCode() { int result = super.hashCode(); result = 7 * result + getRecordKeeperID().hashCode(); return (result); } /** * @see AbstractBaseComponent#getJSONObject() */ public JsonObject getJSONObject() { JsonObject object = new JsonObject(); addJson(object, RECORD_KEEPER_ID_NAME, getRecordKeeperID()); addJson(object, getOrganization()); return (object); } /** * @see AbstractBaseComponent#getHTMLTextOutput(OutputFormat, String, String) */ public String getHTMLTextOutput(OutputFormat format, String prefix, String suffix) { Util.requireHTMLText(format); String localPrefix = buildPrefix(prefix, getName(), suffix + "."); StringBuffer text = new StringBuffer(); text.append(buildHTMLTextOutput(format, localPrefix + RECORD_KEEPER_ID_NAME, getRecordKeeperID())); text.append(getOrganization().getHTMLTextOutput(format, localPrefix, "")); return (text.toString()); } /** * @see AbstractBaseComponent#getNestedComponents() */ protected List<IDDMSComponent> getNestedComponents() { List<IDDMSComponent> list = new ArrayList<IDDMSComponent>(); list.add(getOrganization()); return (list); } /** * Accessor for the element name of this component, based on the version of DDMS used * * @param version the DDMSVersion * @return an element name */ public static String getName(DDMSVersion version) { Util.requireValue("version", version); return ("recordKeeper"); } /** * Accessor for the recordKeeperID */ public String getRecordKeeperID() { return (Util.getFirstDDMSChildValue(getXOMElement(), RECORD_KEEPER_ID_NAME)); } /** * Accessor for the organization */ public Organization getOrganization() { return (_organization); } /** * Builder for this DDMS component. * * @see IBuilder * @author Brian Uri! * @since 2.0.0 */ public static class Builder implements IBuilder, Serializable { private static final long serialVersionUID = 4565840434345629470L; private String _recordKeeperID; private Organization.Builder _organization; /** * Empty constructor */ public Builder() { } /** * Constructor which starts from an existing component. */ public Builder(RecordKeeper keeper) { setRecordKeeperID(keeper.getRecordKeeperID()); setOrganization(new Organization.Builder(keeper.getOrganization())); } /** * @see IBuilder#commit() */ public RecordKeeper commit() throws InvalidDDMSException { return (isEmpty() ? null : new RecordKeeper(getRecordKeeperID(), getOrganization().commit())); } /** * Helper method to determine if any values have been entered. * * @return true if all values are empty */ public boolean isEmpty() { return (getOrganization().isEmpty() && Util.isEmpty(getRecordKeeperID())); } /** * Builder accessor for the recordKeeperID */ public String getRecordKeeperID() { return _recordKeeperID; } /** * Builder accessor for the recordKeeperID */ public void setRecordKeeperID(String recordKeeperID) { _recordKeeperID = recordKeeperID; } /** * Builder accessor for the organization builder */ public Organization.Builder getOrganization() { if (_organization == null) { _organization = new Organization.Builder(); } return _organization; } /** * Builder accessor for the organization builder */ public void setOrganization(Organization.Builder organization) { _organization = organization; } } }