java.lang.Object

ome.xml.model.Channel

All Implemented Interfaces:: OMEModelObject

public class Channel
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type Field Description

static java.lang.String NAMESPACE

Constructor Summary

Constructors
Constructor	Description
`Channel()`	Default constructor.
`Channel(Channel orig)`	Copy constructor.
`Channel(org.w3c.dom.Element element, OMEModel model)`	Constructs Channel recursively from an XML DOM tree.

Method Summary

Modifier and Type	Method	Description
`org.w3c.dom.Element`	`asXMLElement(org.w3c.dom.Document document)`	Takes the entire object hierarchy and produces an XML DOM tree.
`org.w3c.dom.Element`	`asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Channel_element)`	Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`java.util.List<Annotation>`	`copyLinkedAnnotationList()`
`AcquisitionMode`	`getAcquisitionMode()`
`Color`	`getColor()`
`ContrastMethod`	`getContrastMethod()`
`DetectorSettings`	`getDetectorSettings()`
`Length`	`getEmissionWavelength()`
`static java.lang.String`	`getEmissionWavelengthUnitXsdDefault()`
`Length`	`getExcitationWavelength()`
`static java.lang.String`	`getExcitationWavelengthUnitXsdDefault()`
`java.lang.String`	`getFluor()`
`java.lang.String`	`getID()`
`IlluminationType`	`getIlluminationType()`
`LightPath`	`getLightPath()`
`LightSourceSettings`	`getLightSourceSettings()`
`Annotation`	`getLinkedAnnotation(int index)`
`FilterSet`	`getLinkedFilterSet()`
`java.lang.String`	`getName()`
`java.lang.Double`	`getNDFilter()`
`Length`	`getPinholeSize()`
`static java.lang.String`	`getPinholeSizeUnitXsdDefault()`
`Pixels`	`getPixels()`
`java.lang.Integer`	`getPockelCellSetting()`
`PositiveInteger`	`getSamplesPerPixel()`
`boolean`	`link(Reference reference, OMEModelObject o)`	Link a given OME model object to this model object.
`boolean`	`linkAnnotation(Annotation o)`
`void`	`linkFilterSet(FilterSet o)`
`void`	`setAcquisitionMode(AcquisitionMode acquisitionMode)`
`void`	`setColor(Color color)`
`void`	`setContrastMethod(ContrastMethod contrastMethod)`
`void`	`setDetectorSettings(DetectorSettings detectorSettings)`
`void`	`setEmissionWavelength(Length emissionWavelength)`
`void`	`setExcitationWavelength(Length excitationWavelength)`
`void`	`setFluor(java.lang.String fluor)`
`void`	`setID(java.lang.String id)`
`void`	`setIlluminationType(IlluminationType illuminationType)`
`void`	`setLightPath(LightPath lightPath)`
`void`	`setLightSourceSettings(LightSourceSettings lightSourceSettings)`
`Annotation`	`setLinkedAnnotation(int index, Annotation o)`
`void`	`setName(java.lang.String name)`
`void`	`setNDFilter(java.lang.Double ndFilter)`
`void`	`setPinholeSize(Length pinholeSize)`
`void`	`setPixels(Pixels pixels_BackReference)`
`void`	`setPockelCellSetting(java.lang.Integer pockelCellSetting)`
`void`	`setSamplesPerPixel(PositiveInteger samplesPerPixel)`
`int`	`sizeOfLinkedAnnotationList()`
`boolean`	`unlinkAnnotation(Annotation o)`
`void`	`unlinkFilterSet(FilterSet o)`
`void`	`update(org.w3c.dom.Element element, OMEModel model)`	Updates Channel recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.AbstractOMEModelObject

getChildrenByTagName, stripNamespacePrefix

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- NAMESPACE
  
  public static final java.lang.String NAMESPACE
  
  See Also:
  
  Constant Field Values
Constructor Details
- Channel
  
  public Channel()
  
  Default constructor.
- Channel
  
  public Channel(org.w3c.dom.Element element, OMEModel model) throws EnumerationException
  
  Constructs Channel recursively from an XML DOM tree.
  
  Parameters:
  
  element - Root of the XML DOM tree to construct a model object graph from.
  
  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.
- Channel
  
  public Channel(Channel orig)
  
  Copy constructor.
Method Details
- update
  
  public void update(org.w3c.dom.Element element, OMEModel model) throws EnumerationException
  
  Updates Channel recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.
  
  Specified by:
  
  update in interface OMEModelObject
  
  Overrides:
  
  update in class AbstractOMEModelObject
  
  Parameters:
  
  element - Root of the XML DOM tree to construct a model object graph from.
  
  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.
- link
  
  public boolean link(Reference reference, OMEModelObject o)
  
  Description copied from interface: OMEModelObject
  
  Link a given OME model object to this model object.
  
  Specified by:
  
  link in interface OMEModelObject
  
  Overrides:
  
  link in class AbstractOMEModelObject
  
  Parameters:
  
  reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.
  
  o - Model object to link to.
  
  Returns:
  
  true if this model object was able to handle the reference, false otherwise.
- getID
  
  public java.lang.String getID()
- setID
  
  public void setID(java.lang.String id)
- getName
  
  public java.lang.String getName()
- setName
  
  public void setName(java.lang.String name)
- getSamplesPerPixel
  
  public PositiveInteger getSamplesPerPixel()
- setSamplesPerPixel
  
  public void setSamplesPerPixel(PositiveInteger samplesPerPixel)
- getIlluminationType
  
  public IlluminationType getIlluminationType()
- setIlluminationType
  
  public void setIlluminationType(IlluminationType illuminationType)
- getPinholeSize
  
  public Length getPinholeSize()
- setPinholeSize
  
  public void setPinholeSize(Length pinholeSize)
- getPinholeSizeUnitXsdDefault
  
  public static java.lang.String getPinholeSizeUnitXsdDefault()
- getAcquisitionMode
  
  public AcquisitionMode getAcquisitionMode()
- setAcquisitionMode
  
  public void setAcquisitionMode(AcquisitionMode acquisitionMode)
- getContrastMethod
  
  public ContrastMethod getContrastMethod()
- setContrastMethod
  
  public void setContrastMethod(ContrastMethod contrastMethod)
- getExcitationWavelength
  
  public Length getExcitationWavelength()
- setExcitationWavelength
  
  public void setExcitationWavelength(Length excitationWavelength)
- getExcitationWavelengthUnitXsdDefault
  
  public static java.lang.String getExcitationWavelengthUnitXsdDefault()
- getEmissionWavelength
  
  public Length getEmissionWavelength()
- setEmissionWavelength
  
  public void setEmissionWavelength(Length emissionWavelength)
- getEmissionWavelengthUnitXsdDefault
  
  public static java.lang.String getEmissionWavelengthUnitXsdDefault()
- getFluor
  
  public java.lang.String getFluor()
- setFluor
  
  public void setFluor(java.lang.String fluor)
- getNDFilter
  
  public java.lang.Double getNDFilter()
- setNDFilter
  
  public void setNDFilter(java.lang.Double ndFilter)
- getPockelCellSetting
  
  public java.lang.Integer getPockelCellSetting()
- setPockelCellSetting
  
  public void setPockelCellSetting(java.lang.Integer pockelCellSetting)
- getColor
  
  public Color getColor()
- setColor
  
  public void setColor(Color color)
- getLightSourceSettings
  
  public LightSourceSettings getLightSourceSettings()
- setLightSourceSettings
  
  public void setLightSourceSettings(LightSourceSettings lightSourceSettings)
- getDetectorSettings
  
  public DetectorSettings getDetectorSettings()
- setDetectorSettings
  
  public void setDetectorSettings(DetectorSettings detectorSettings)
- getLinkedFilterSet
  
  public FilterSet getLinkedFilterSet()
- linkFilterSet
  
  public void linkFilterSet(FilterSet o)
- unlinkFilterSet
  
  public void unlinkFilterSet(FilterSet o)
- sizeOfLinkedAnnotationList
  
  public int sizeOfLinkedAnnotationList()
- copyLinkedAnnotationList
  
  public java.util.List<Annotation> copyLinkedAnnotationList()
- getLinkedAnnotation
  
  public Annotation getLinkedAnnotation(int index)
- setLinkedAnnotation
  
  public Annotation setLinkedAnnotation(int index, Annotation o)
- linkAnnotation
  
  public boolean linkAnnotation(Annotation o)
- unlinkAnnotation
  
  public boolean unlinkAnnotation(Annotation o)
- getLightPath
  
  public LightPath getLightPath()
- setLightPath
  
  public void setLightPath(LightPath lightPath)
- getPixels
  
  public Pixels getPixels()
- setPixels
  
  public void setPixels(Pixels pixels_BackReference)
- asXMLElement
  
  public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document)
  
  Description copied from interface: OMEModelObject
  
  Takes the entire object hierarchy and produces an XML DOM tree.
  
  Specified by:
  
  asXMLElement in interface OMEModelObject
  
  Specified by:
  
  asXMLElement in class AbstractOMEModelObject
  
  Parameters:
  
  document - Destination document for element creation, etc.
  
  Returns:
  
  XML DOM tree root element for this model object.
- asXMLElement
  
  public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Channel_element)
  
  Description copied from class: AbstractOMEModelObject
  
  Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
  
  Overrides:
  
  asXMLElement in class AbstractOMEModelObject
  
  Parameters:
  
  document - Destination document for element creation, etc.
  
  Channel_element - Element from the subclass. If null a new element will be created of this class.
  
  Returns:
  
  element populated with properties from this class.

Class Channel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ome.xml.model.AbstractOMEModelObject

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details