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

  // -- Instance variables --

  // Type property
  private LaserType type;

  // LaserMedium property
  private LaserMedium laserMedium;

  // Wavelength property
  private Length wavelength;

  // FrequencyMultiplication property
  private PositiveInteger frequencyMultiplication;

  // Tuneable property
  private Boolean tuneable;

  // Pulse property
  private Pulse pulse;

  // PockelCell property
  private Boolean pockelCell;

  // RepetitionRate property
  private Frequency repetitionRate;

  // Pump reference
  private LightSource pump;

  // -- Constructors --

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



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

  /** Copy constructor. */
  public Laser(Laser orig)
  {
    super(orig);
    type = orig.type;
    laserMedium = orig.laserMedium;
    wavelength = orig.wavelength;
    frequencyMultiplication = orig.frequencyMultiplication;
    tuneable = orig.tuneable;
    pulse = orig.pulse;
    pockelCell = orig.pockelCell;
    repetitionRate = orig.repetitionRate;
    pump = orig.pump;
  }

  // -- Custom content from Laser specific template --


  // -- OMEModelObject API methods --

  /**
   * Updates Laser 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("Type"))
    {
      // Attribute property which is an enumeration Type
      setType(LaserType.fromString(
        element.getAttribute("Type")));
    }
    if (element.hasAttribute("LaserMedium"))
    {
      // Attribute property which is an enumeration LaserMedium
      setLaserMedium(LaserMedium.fromString(
        element.getAttribute("LaserMedium")));
    }
    if (element.hasAttribute("Wavelength"))
    {
      // Attribute property Wavelength with unit companion WavelengthUnit
      String unitSymbol = element.getAttribute("WavelengthUnit");
      if ((unitSymbol == null) || (unitSymbol.isEmpty()))
      {
        // Use default value specified in the xsd model
        unitSymbol = getWavelengthUnitXsdDefault();
      }
      UnitsLength modelUnit =
        UnitsLength.fromString(unitSymbol);
      PositiveFloat baseValue = PositiveFloat.valueOf(
        element.getAttribute("Wavelength"));
      setWavelength(UnitsLengthEnumHandler.getQuantity(baseValue, modelUnit));
    }
    if (element.hasAttribute("FrequencyMultiplication"))
    {
      // Attribute property FrequencyMultiplication
      setFrequencyMultiplication(PositiveInteger.valueOf(
        element.getAttribute("FrequencyMultiplication")));
    }
    if (element.hasAttribute("Tuneable"))
    {
      // Attribute property Tuneable
      setTuneable(Boolean.valueOf(
        element.getAttribute("Tuneable")));
    }
    if (element.hasAttribute("Pulse"))
    {
      // Attribute property which is an enumeration Pulse
      setPulse(Pulse.fromString(
        element.getAttribute("Pulse")));
    }
    if (element.hasAttribute("PockelCell"))
    {
      // Attribute property PockelCell
      setPockelCell(Boolean.valueOf(
        element.getAttribute("PockelCell")));
    }
    if (element.hasAttribute("RepetitionRate"))
    {
      // Attribute property RepetitionRate with unit companion RepetitionRateUnit
      String unitSymbol = element.getAttribute("RepetitionRateUnit");
      if ((unitSymbol == null) || (unitSymbol.isEmpty()))
      {
        // Use default value specified in the xsd model
        unitSymbol = getRepetitionRateUnitXsdDefault();
      }
      UnitsFrequency modelUnit =
        UnitsFrequency.fromString(unitSymbol);
      Double baseValue = Double.valueOf(
        element.getAttribute("RepetitionRate"));
      setRepetitionRate(UnitsFrequencyEnumHandler.getQuantity(baseValue, modelUnit));
    }
    // Element reference Pump
    List Pump_nodeList =
      getChildrenByTagName(element, "Pump");
    for (Element Pump_element : Pump_nodeList)
    {
      Pump pump_reference = new Pump();
      pump_reference.setID(Pump_element.getAttribute("ID"));
      model.addReference(this, pump_reference);
    }
  }

  // -- Laser API methods --

  public boolean link(Reference reference, OMEModelObject o)
  {
    if (reference instanceof Pump)
    {
      pump = (LightSource) o;
      return true;
    }
    return super.link(reference, o);
  }

  // Property Type
  public LaserType getType()
  {
    return type;
  }

  public void setType(LaserType type)
  {
    this.type = type;
  }

  // Property LaserMedium
  public LaserMedium getLaserMedium()
  {
    return laserMedium;
  }

  public void setLaserMedium(LaserMedium laserMedium)
  {
    this.laserMedium = laserMedium;
  }

  // Property Wavelength with unit companion WavelengthUnit
  public Length getWavelength()
  {
    return wavelength;
  }

  public void setWavelength(Length wavelength)
  {
    this.wavelength = wavelength;
  }

  // Property WavelengthUnit is a unit companion
  @SuppressWarnings("SameReturnValue")
  public static String getWavelengthUnitXsdDefault()
  {
    return "nm";
  }

  // Property FrequencyMultiplication
  public PositiveInteger getFrequencyMultiplication()
  {
    return frequencyMultiplication;
  }

  public void setFrequencyMultiplication(PositiveInteger frequencyMultiplication)
  {
    this.frequencyMultiplication = frequencyMultiplication;
  }

  // Property Tuneable
  public Boolean getTuneable()
  {
    return tuneable;
  }

  public void setTuneable(Boolean tuneable)
  {
    this.tuneable = tuneable;
  }

  // Property Pulse
  public Pulse getPulse()
  {
    return pulse;
  }

  public void setPulse(Pulse pulse)
  {
    this.pulse = pulse;
  }

  // Property PockelCell
  public Boolean getPockelCell()
  {
    return pockelCell;
  }

  public void setPockelCell(Boolean pockelCell)
  {
    this.pockelCell = pockelCell;
  }

  // Property RepetitionRate with unit companion RepetitionRateUnit
  public Frequency getRepetitionRate()
  {
    return repetitionRate;
  }

  public void setRepetitionRate(Frequency repetitionRate)
  {
    this.repetitionRate = repetitionRate;
  }

  // Property RepetitionRateUnit is a unit companion
  @SuppressWarnings("SameReturnValue")
  public static String getRepetitionRateUnitXsdDefault()
  {
    return "Hz";
  }

  // Reference
  public LightSource getLinkedPump()
  {
    return pump;
  }

  public void linkPump(LightSource o)
  {
    pump = o;
  }

  public void unlinkPump(LightSource o)
  {
    if (pump == o)
    {
      pump = null;
    }
  }

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

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

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

    if (type != null)
    {
      // Attribute property Type
      Laser_element.setAttribute("Type", type.toString());
    }
    if (laserMedium != null)
    {
      // Attribute property LaserMedium
      Laser_element.setAttribute("LaserMedium", laserMedium.toString());
    }
    if (wavelength != null)
    {
      // Attribute property Wavelength with units companion prop.unitsCompanion.name
      if (wavelength.value() != null)
      {


        Laser_element.setAttribute("Wavelength", wavelength.value().toString());

      }
      if (wavelength.unit() != null)
      {
        try
        {
          UnitsLength enumUnits = UnitsLength.fromString(wavelength.unit().getSymbol());
          Laser_element.setAttribute("WavelengthUnit", enumUnits.toString());
        } catch (EnumerationException e)
        {
          LOGGER.debug("Unable to create xml for Laser:WavelengthUnit: {}", e.toString());
        }
      }
    }
    if (frequencyMultiplication != null)
    {
      // Attribute property FrequencyMultiplication
      Laser_element.setAttribute("FrequencyMultiplication", frequencyMultiplication.toString());
    }
    if (tuneable != null)
    {
      // Attribute property Tuneable
      Laser_element.setAttribute("Tuneable", tuneable.toString());
    }
    if (pulse != null)
    {
      // Attribute property Pulse
      Laser_element.setAttribute("Pulse", pulse.toString());
    }
    if (pockelCell != null)
    {
      // Attribute property PockelCell
      Laser_element.setAttribute("PockelCell", pockelCell.toString());
    }
    if (repetitionRate != null)
    {
      // Attribute property RepetitionRate with units companion prop.unitsCompanion.name
      if (repetitionRate.value() != null)
      {


        Laser_element.setAttribute("RepetitionRate", repetitionRate.value().toString());

      }
      if (repetitionRate.unit() != null)
      {
        try
        {
          UnitsFrequency enumUnits = UnitsFrequency.fromString(repetitionRate.unit().getSymbol());
          Laser_element.setAttribute("RepetitionRateUnit", enumUnits.toString());
        } catch (EnumerationException e)
        {
          LOGGER.debug("Unable to create xml for Laser:RepetitionRateUnit: {}", e.toString());
        }
      }
    }
    if (pump != null)
    {
      // Reference property Pump
      Pump o = new Pump();
      o.setID(pump.getID());
      Element child =
        document.createElementNS(NAMESPACE, "Pump");
      o.asXMLElement(document, child);
      Laser_element.appendChild(child);
    }

    return Laser_element;
  }
}