ome.xml.model.LightPath 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
Show all versions of ome-xml Show documentation
OME XML model and metadata classes
/*
* #%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 LightPath extends AbstractOMEModelObject
{
// Base: -- Name: LightPath -- Type: LightPath -- 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(LightPath.class);
// -- Instance variables --
// ExcitationFilterRef reference (occurs more than once)
private List excitationFilterLinks = new ReferenceList();
// DichroicRef reference
private Dichroic dichroic;
// EmissionFilterRef reference (occurs more than once)
private List emissionFilterLinks = new ReferenceList();
// AnnotationRef reference (occurs more than once)
private List annotationLinks = new ReferenceList();
// -- Constructors --
/** Default constructor. */
public LightPath()
{
}
/**
* Constructs LightPath 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 LightPath(Element element, OMEModel model)
throws EnumerationException
{
update(element, model);
}
/** Copy constructor. */
public LightPath(LightPath orig)
{
excitationFilterLinks = orig.excitationFilterLinks;
dichroic = orig.dichroic;
emissionFilterLinks = orig.emissionFilterLinks;
annotationLinks = orig.annotationLinks;
}
// -- Custom content from LightPath specific template --
// -- OMEModelObject API methods --
/**
* Updates LightPath 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();
// Element reference ExcitationFilterRef
List ExcitationFilterRef_nodeList =
getChildrenByTagName(element, "ExcitationFilterRef");
for (Element ExcitationFilterRef_element : ExcitationFilterRef_nodeList)
{
ExcitationFilterRef excitationFilterLinks_reference = new ExcitationFilterRef();
excitationFilterLinks_reference.setID(ExcitationFilterRef_element.getAttribute("ID"));
model.addReference(this, excitationFilterLinks_reference);
}
// Element reference DichroicRef
List DichroicRef_nodeList =
getChildrenByTagName(element, "DichroicRef");
for (Element DichroicRef_element : DichroicRef_nodeList)
{
DichroicRef dichroic_reference = new DichroicRef();
dichroic_reference.setID(DichroicRef_element.getAttribute("ID"));
model.addReference(this, dichroic_reference);
}
// Element reference EmissionFilterRef
List EmissionFilterRef_nodeList =
getChildrenByTagName(element, "EmissionFilterRef");
for (Element EmissionFilterRef_element : EmissionFilterRef_nodeList)
{
EmissionFilterRef emissionFilterLinks_reference = new EmissionFilterRef();
emissionFilterLinks_reference.setID(EmissionFilterRef_element.getAttribute("ID"));
model.addReference(this, emissionFilterLinks_reference);
}
// Element reference AnnotationRef
List AnnotationRef_nodeList =
getChildrenByTagName(element, "AnnotationRef");
for (Element AnnotationRef_element : AnnotationRef_nodeList)
{
AnnotationRef annotationLinks_reference = new AnnotationRef();
annotationLinks_reference.setID(AnnotationRef_element.getAttribute("ID"));
model.addReference(this, annotationLinks_reference);
}
}
// -- LightPath API methods --
public boolean link(Reference reference, OMEModelObject o)
{
if (reference instanceof ExcitationFilterRef)
{
Filter o_casted = (Filter) o;
o_casted.linkLightPathExcitationFilter(this);
excitationFilterLinks.add(o_casted);
return true;
}
if (reference instanceof DichroicRef)
{
Dichroic o_casted = (Dichroic) o;
o_casted.linkLightPath(this);
dichroic = o_casted;
return true;
}
if (reference instanceof EmissionFilterRef)
{
Filter o_casted = (Filter) o;
o_casted.linkLightPathEmissionFilter(this);
emissionFilterLinks.add(o_casted);
return true;
}
if (reference instanceof AnnotationRef)
{
Annotation o_casted = (Annotation) o;
o_casted.linkLightPath(this);
annotationLinks.add(o_casted);
return true;
}
return super.link(reference, o);
}
// Reference which occurs more than once
public int sizeOfLinkedExcitationFilterList()
{
return excitationFilterLinks.size();
}
public List copyLinkedExcitationFilterList()
{
return new ArrayList(excitationFilterLinks);
}
public Filter getLinkedExcitationFilter(int index)
{
return excitationFilterLinks.get(index);
}
public Filter setLinkedExcitationFilter(int index, Filter o)
{
return excitationFilterLinks.set(index, o);
}
public boolean linkExcitationFilter(Filter o)
{
o.linkLightPathExcitationFilter(this);
return excitationFilterLinks.add(o);
}
public boolean unlinkExcitationFilter(Filter o)
{
o.unlinkLightPathExcitationFilter(this);
return excitationFilterLinks.remove(o);
}
// Reference
public Dichroic getLinkedDichroic()
{
return dichroic;
}
public void linkDichroic(Dichroic o)
{
dichroic = o;
}
public void unlinkDichroic(Dichroic o)
{
if (dichroic == o)
{
dichroic = null;
}
}
// Reference which occurs more than once
public int sizeOfLinkedEmissionFilterList()
{
return emissionFilterLinks.size();
}
public List copyLinkedEmissionFilterList()
{
return new ArrayList(emissionFilterLinks);
}
public Filter getLinkedEmissionFilter(int index)
{
return emissionFilterLinks.get(index);
}
public Filter setLinkedEmissionFilter(int index, Filter o)
{
return emissionFilterLinks.set(index, o);
}
public boolean linkEmissionFilter(Filter o)
{
o.linkLightPathEmissionFilter(this);
return emissionFilterLinks.add(o);
}
public boolean unlinkEmissionFilter(Filter o)
{
o.unlinkLightPathEmissionFilter(this);
return emissionFilterLinks.remove(o);
}
// Reference which occurs more than once
public int sizeOfLinkedAnnotationList()
{
return annotationLinks.size();
}
public List copyLinkedAnnotationList()
{
return new ArrayList(annotationLinks);
}
public Annotation getLinkedAnnotation(int index)
{
return annotationLinks.get(index);
}
public Annotation setLinkedAnnotation(int index, Annotation o)
{
return annotationLinks.set(index, o);
}
public boolean linkAnnotation(Annotation o)
{
o.linkLightPath(this);
return annotationLinks.add(o);
}
public boolean unlinkAnnotation(Annotation o)
{
o.unlinkLightPath(this);
return annotationLinks.remove(o);
}
public Element asXMLElement(Document document)
{
return asXMLElement(document, null);
}
public Element asXMLElement(Document document, Element LightPath_element)
{
// Creating XML block for LightPath
if (LightPath_element == null)
{
LightPath_element =
document.createElementNS(NAMESPACE, "LightPath");
}
// Ensure any base annotations add their Elements first
super.asXMLElement(document, LightPath_element);
if (excitationFilterLinks != null)
{
// Reference property ExcitationFilterRef which occurs more than once
for (Filter excitationFilterLinks_value : excitationFilterLinks)
{
ExcitationFilterRef o = new ExcitationFilterRef();
o.setID(excitationFilterLinks_value.getID());
Element child =
document.createElementNS(NAMESPACE, "ExcitationFilterRef");
o.asXMLElement(document, child);
LightPath_element.appendChild(child);
}
}
if (dichroic != null)
{
// Reference property DichroicRef
DichroicRef o = new DichroicRef();
o.setID(dichroic.getID());
Element child =
document.createElementNS(NAMESPACE, "DichroicRef");
o.asXMLElement(document, child);
LightPath_element.appendChild(child);
}
if (emissionFilterLinks != null)
{
// Reference property EmissionFilterRef which occurs more than once
for (Filter emissionFilterLinks_value : emissionFilterLinks)
{
EmissionFilterRef o = new EmissionFilterRef();
o.setID(emissionFilterLinks_value.getID());
Element child =
document.createElementNS(NAMESPACE, "EmissionFilterRef");
o.asXMLElement(document, child);
LightPath_element.appendChild(child);
}
}
if (annotationLinks != null)
{
// Reference property AnnotationRef which occurs more than once
for (Annotation annotationLinks_value : annotationLinks)
{
AnnotationRef o = new AnnotationRef();
o.setID(annotationLinks_value.getID());
Element child =
document.createElementNS(NAMESPACE, "AnnotationRef");
o.asXMLElement(document, child);
LightPath_element.appendChild(child);
}
}
return LightPath_element;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy