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

Go to download
/*
 * #%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 TiffData extends AbstractOMEModelObject
{
  // Base:  -- Name: TiffData -- Type: TiffData -- 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(TiffData.class);

  // -- Instance variables --

  // IFD property
  private NonNegativeInteger ifd;

  // FirstZ property
  private NonNegativeInteger firstZ;

  // FirstT property
  private NonNegativeInteger firstT;

  // FirstC property
  private NonNegativeInteger firstC;

  // PlaneCount property
  private NonNegativeInteger planeCount;

  // UUID property
  private UUID uuid;

  // Pixels_BackReference back reference
  private Pixels pixels;

  // -- Constructors --

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



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

  /** Copy constructor. */
  public TiffData(TiffData orig)
  {
    ifd = orig.ifd;
    firstZ = orig.firstZ;
    firstT = orig.firstT;
    firstC = orig.firstC;
    planeCount = orig.planeCount;
    uuid = orig.uuid;
    pixels = orig.pixels;
  }

  // -- Custom content from TiffData specific template --


  // -- OMEModelObject API methods --

  /**
   * Updates TiffData 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("IFD"))
    {
      // Attribute property IFD
      setIFD(NonNegativeInteger.valueOf(
        element.getAttribute("IFD")));
    }
    if (element.hasAttribute("FirstZ"))
    {
      // Attribute property FirstZ
      setFirstZ(NonNegativeInteger.valueOf(
        element.getAttribute("FirstZ")));
    }
    if (element.hasAttribute("FirstT"))
    {
      // Attribute property FirstT
      setFirstT(NonNegativeInteger.valueOf(
        element.getAttribute("FirstT")));
    }
    if (element.hasAttribute("FirstC"))
    {
      // Attribute property FirstC
      setFirstC(NonNegativeInteger.valueOf(
        element.getAttribute("FirstC")));
    }
    if (element.hasAttribute("PlaneCount"))
    {
      // Attribute property PlaneCount
      setPlaneCount(NonNegativeInteger.valueOf(
        element.getAttribute("PlaneCount")));
    }
    List UUID_nodeList =
      getChildrenByTagName(element, "UUID");
    if (UUID_nodeList.size() > 1)
    {
      // TODO: Should be its own Exception
      throw new RuntimeException(String.format(
        "UUID node list size %d != 1",
        UUID_nodeList.size()));
    }
    else if (UUID_nodeList.size() != 0)
    {
      // Element property UUID which is complex (has
      // sub-elements)
      setUUID(new UUID(
        (Element) UUID_nodeList.get(0), model));
    }
  }

  // -- TiffData API methods --

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

  // Property IFD
  public NonNegativeInteger getIFD()
  {
    return ifd;
  }

  public void setIFD(NonNegativeInteger ifd)
  {
    this.ifd = ifd;
  }

  // Property FirstZ
  public NonNegativeInteger getFirstZ()
  {
    return firstZ;
  }

  public void setFirstZ(NonNegativeInteger firstZ)
  {
    this.firstZ = firstZ;
  }

  // Property FirstT
  public NonNegativeInteger getFirstT()
  {
    return firstT;
  }

  public void setFirstT(NonNegativeInteger firstT)
  {
    this.firstT = firstT;
  }

  // Property FirstC
  public NonNegativeInteger getFirstC()
  {
    return firstC;
  }

  public void setFirstC(NonNegativeInteger firstC)
  {
    this.firstC = firstC;
  }

  // Property PlaneCount
  public NonNegativeInteger getPlaneCount()
  {
    return planeCount;
  }

  public void setPlaneCount(NonNegativeInteger planeCount)
  {
    this.planeCount = planeCount;
  }

  // Property UUID
  public UUID getUUID()
  {
    return uuid;
  }

  public void setUUID(UUID uuid)
  {
    this.uuid = uuid;
  }

  // Property Pixels_BackReference
  public Pixels getPixels()
  {
    return pixels;
  }

  public void setPixels(Pixels pixels_BackReference)
  {
    this.pixels = pixels_BackReference;
  }

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

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

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

    if (ifd != null)
    {
      // Attribute property IFD
      TiffData_element.setAttribute("IFD", ifd.toString());
    }
    if (firstZ != null)
    {
      // Attribute property FirstZ
      TiffData_element.setAttribute("FirstZ", firstZ.toString());
    }
    if (firstT != null)
    {
      // Attribute property FirstT
      TiffData_element.setAttribute("FirstT", firstT.toString());
    }
    if (firstC != null)
    {
      // Attribute property FirstC
      TiffData_element.setAttribute("FirstC", firstC.toString());
    }
    if (planeCount != null)
    {
      // Attribute property PlaneCount
      TiffData_element.setAttribute("PlaneCount", planeCount.toString());
    }
    if (uuid != null)
    {
      // Element property UUID which is complex (has
      // sub-elements)
      Element child =
        document.createElementNS(NAMESPACE, "UUID");
      uuid.asXMLElement(document, child);
      TiffData_element.appendChild(child);
    }
    if (pixels != null)
    {
      // *** IGNORING *** Skipped back reference Pixels_BackReference
    }

    return TiffData_element;
  }
}