ome.xml.model.Line 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 Line extends Shape
{
  // Base: Shape -- Name: Line -- Type: Line -- modelBaseType: Shape -- 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(Line.class);

  // -- Instance variables --

  // X1 property
  private Double x1;

  // Y1 property
  private Double y1;

  // X2 property
  private Double x2;

  // Y2 property
  private Double y2;

  // MarkerStart property
  private Marker markerStart;

  // MarkerEnd property
  private Marker markerEnd;

  // -- Constructors --

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



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

  /** Copy constructor. */
  public Line(Line orig)
  {
    super(orig);
    x1 = orig.x1;
    y1 = orig.y1;
    x2 = orig.x2;
    y2 = orig.y2;
    markerStart = orig.markerStart;
    markerEnd = orig.markerEnd;
  }

  // -- Custom content from Line specific template --


  // -- OMEModelObject API methods --

  /**
   * Updates Line 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);
    if (element.hasAttribute("X1"))
    {
      // Attribute property X1
      setX1(Double.valueOf(
        element.getAttribute("X1")));
    }
    if (element.hasAttribute("Y1"))
    {
      // Attribute property Y1
      setY1(Double.valueOf(
        element.getAttribute("Y1")));
    }
    if (element.hasAttribute("X2"))
    {
      // Attribute property X2
      setX2(Double.valueOf(
        element.getAttribute("X2")));
    }
    if (element.hasAttribute("Y2"))
    {
      // Attribute property Y2
      setY2(Double.valueOf(
        element.getAttribute("Y2")));
    }
    if (element.hasAttribute("MarkerStart"))
    {
      // Attribute property which is an enumeration MarkerStart
      setMarkerStart(Marker.fromString(
        element.getAttribute("MarkerStart")));
    }
    if (element.hasAttribute("MarkerEnd"))
    {
      // Attribute property which is an enumeration MarkerEnd
      setMarkerEnd(Marker.fromString(
        element.getAttribute("MarkerEnd")));
    }
  }

  // -- Line API methods --

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

  // Property X1
  public Double getX1()
  {
    return x1;
  }

  public void setX1(Double x1)
  {
    this.x1 = x1;
  }

  // Property Y1
  public Double getY1()
  {
    return y1;
  }

  public void setY1(Double y1)
  {
    this.y1 = y1;
  }

  // Property X2
  public Double getX2()
  {
    return x2;
  }

  public void setX2(Double x2)
  {
    this.x2 = x2;
  }

  // Property Y2
  public Double getY2()
  {
    return y2;
  }

  public void setY2(Double y2)
  {
    this.y2 = y2;
  }

  // Property MarkerStart
  public Marker getMarkerStart()
  {
    return markerStart;
  }

  public void setMarkerStart(Marker markerStart)
  {
    this.markerStart = markerStart;
  }

  // Property MarkerEnd
  public Marker getMarkerEnd()
  {
    return markerEnd;
  }

  public void setMarkerEnd(Marker markerEnd)
  {
    this.markerEnd = markerEnd;
  }

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

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

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

    if (x1 != null)
    {
      // Attribute property X1
      Line_element.setAttribute("X1", x1.toString());
    }
    if (y1 != null)
    {
      // Attribute property Y1
      Line_element.setAttribute("Y1", y1.toString());
    }
    if (x2 != null)
    {
      // Attribute property X2
      Line_element.setAttribute("X2", x2.toString());
    }
    if (y2 != null)
    {
      // Attribute property Y2
      Line_element.setAttribute("Y2", y2.toString());
    }
    if (markerStart != null)
    {
      // Attribute property MarkerStart
      Line_element.setAttribute("MarkerStart", markerStart.toString());
    }
    if (markerEnd != null)
    {
      // Attribute property MarkerEnd
      Line_element.setAttribute("MarkerEnd", markerEnd.toString());
    }

    return Line_element;
  }
}