ome.xml.model.DoubleAnnotation 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
A library for working with OME-XML metadata structures.
The newest version!
/*
 * #%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.xml.model.enums.*;
import ome.xml.model.enums.handlers.*;
import ome.xml.model.primitives.*;
import ome.units.quantity.*;
import ome.units.unit.Unit;

public class DoubleAnnotation extends NumericAnnotation
{
  // Base: NumericAnnotation -- Name: DoubleAnnotation -- Type: DoubleAnnotation -- modelBaseType: NumericAnnotation -- 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(DoubleAnnotation.class);

  // -- Instance variables --

  // Value property
  private Double value;

  // StructuredAnnotations_BackReference back reference
  private StructuredAnnotations structuredAnnotations;

  // -- Constructors --

  /** Default constructor. */
  public DoubleAnnotation()
  {
    super();
  }



  /**
   * Constructs DoubleAnnotation 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 DoubleAnnotation(Element element, OMEModel model)
    throws EnumerationException
  {
    update(element, model);
  }

  /** Copy constructor. */
  public DoubleAnnotation(DoubleAnnotation orig)
  {
    super(orig);
    value = orig.value;
    structuredAnnotations = orig.structuredAnnotations;
  }

  // -- Custom content from DoubleAnnotation specific template --


  // -- OMEModelObject API methods --

  /**
   * Updates DoubleAnnotation 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);
    List Value_nodeList =
      getChildrenByTagName(element, "Value");
    if (Value_nodeList.size() > 1)
    {
      // TODO: Should be its own Exception
      throw new RuntimeException(String.format(
        "Value node list size %d != 1",
        Value_nodeList.size()));
    }
    else if (Value_nodeList.size() != 0)
    {
      // Element property Value which is not complex (has no
      // sub-elements)
      setValue(
        Double.valueOf(Value_nodeList.get(0).getTextContent()));
    }
  }

  // -- DoubleAnnotation API methods --

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

  // Property Value
  public Double getValue()
  {
    return value;
  }

  public void setValue(Double value)
  {
    this.value = value;
  }

  // Property StructuredAnnotations_BackReference
  public StructuredAnnotations getStructuredAnnotations()
  {
    return structuredAnnotations;
  }

  public void setStructuredAnnotations(StructuredAnnotations structuredAnnotations_BackReference)
  {
    this.structuredAnnotations = structuredAnnotations_BackReference;
  }

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

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

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

    if (value != null)
    {
    // Element property Value which is not complex (has no
    // sub-elements)
    Element value_element =
      document.createElementNS(NAMESPACE, "Value");
      value_element.setTextContent(value.toString());
      DoubleAnnotation_element.appendChild(value_element);
    }
    // *** IGNORING *** Skipped back reference StructuredAnnotations_BackReference

    return DoubleAnnotation_element;
  }
}