ome.xml.model.External Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ome-xml Show documentation
OME XML model and metadata classes
There is a newer version: 6.0.0
/*
 * #%L
 * OME-XML Java library for working with OME-XML metadata structures.
 * %%
 * Copyright (C) 2006 - 2016 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

/*-----------------------------------------------------------------------------
 *
 * THIS IS AUTOMATICALLY GENERATED CODE.  DO NOT MODIFY.
 *
 *-----------------------------------------------------------------------------
 */

package ome.xml.model;

import java.util.ArrayList;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import ome.units.quantity.Angle;
import ome.units.quantity.ElectricPotential;
import ome.units.quantity.Frequency;
import ome.units.quantity.Length;
import ome.units.quantity.Power;
import ome.units.quantity.Pressure;
import ome.units.quantity.Temperature;
import ome.units.quantity.Time;
import ome.units.unit.Unit;

import ome.xml.model.enums.*;
import ome.xml.model.enums.handlers.*;
import ome.xml.model.primitives.*;

public class External extends AbstractOMEModelObject
{
  // Base:  -- Name: External -- Type: External -- modelBaseType: AbstractOMEModelObject -- langBaseType: Object

  // -- Constants --

  public static final String NAMESPACE = "http://www.openmicroscopy.org/Schemas/OME/2016-06";

  /** Logger for this class. */
  private static final Logger LOGGER =
    LoggerFactory.getLogger(External.class);

  // -- Instance variables --

  // href property
  private String href;

  // SHA1 property
  private String sha1;

  // Compression property
  private Compression compression;

  // -- Constructors --

  /** Default constructor. */
  public External()
  {
  }



  /**
   * Constructs External recursively from an XML DOM tree.
   * @param element Root of the XML DOM tree to construct a model object
   * graph from.
   * @param model Handler for the OME model which keeps track of instances
   * and references seen during object population.
   * @throws EnumerationException If there is an error instantiating an
   * enumeration during model object creation.
   */
  public External(Element element, OMEModel model)
    throws EnumerationException
  {
    update(element, model);
  }

  /** Copy constructor. */
  public External(External orig)
  {
    href = orig.href;
    sha1 = orig.sha1;
    compression = orig.compression;
  }

  // -- Custom content from External specific template --


  // -- OMEModelObject API methods --

  /**
   * Updates External recursively from an XML DOM tree. NOTE: No
   * properties are removed, only added or updated.
   * @param element Root of the XML DOM tree to construct a model object
   * graph from.
   * @param model Handler for the OME model which keeps track of instances
   * and references seen during object population.
   * @throws EnumerationException If there is an error instantiating an
   * enumeration during model object creation.
   */
  public void update(Element element, OMEModel model)
    throws EnumerationException
  {
    super.update(element, model);
    String tagName = element.getTagName();
    if (element.hasAttribute("href"))
    {
      // Attribute property href
      sethref(String.valueOf(
        element.getAttribute("href")));
    }
    if (element.hasAttribute("SHA1"))
    {
      // Attribute property SHA1
      setSHA1(String.valueOf(
        element.getAttribute("SHA1")));
    }
    if (element.hasAttribute("Compression"))
    {
      // Attribute property which is an enumeration Compression
      setCompression(Compression.fromString(
        element.getAttribute("Compression")));
    }
  }

  // -- External API methods --

  public boolean link(Reference reference, OMEModelObject o)
  {
    return super.link(reference, o);
  }

  // Property href
  public String gethref()
  {
    return href;
  }

  public void sethref(String href)
  {
    this.href = href;
  }

  // Property SHA1
  public String getSHA1()
  {
    return sha1;
  }

  public void setSHA1(String sha1)
  {
    this.sha1 = sha1;
  }

  // Property Compression
  public Compression getCompression()
  {
    return compression;
  }

  public void setCompression(Compression compression)
  {
    this.compression = compression;
  }

  public Element asXMLElement(Document document)
  {
    return asXMLElement(document, null);
  }

  public Element asXMLElement(Document document, Element External_element)
  {
    // Creating XML block for External
    if (External_element == null)
    {
      External_element =
        document.createElementNS(NAMESPACE, "External");
    }

    // Ensure any base annotations add their Elements first
    super.asXMLElement(document, External_element);

    if (href != null)
    {
      // Attribute property href
      External_element.setAttribute("href", href.toString());
    }
    if (sha1 != null)
    {
      // Attribute property SHA1
      External_element.setAttribute("SHA1", sha1.toString());
    }
    if (compression != null)
    {
      // Attribute property Compression
      External_element.setAttribute("Compression", compression.toString());
    }

    return External_element;
  }
}