Channel (OME XML library 6.3.4 API)

java.lang.Object
- ome.xml.model.AbstractOMEModelObject
- - ome.xml.model.Channel

All Implemented Interfaces:: OMEModelObject

public class Channel
extends AbstractOMEModelObject

Field Summary

Fields
Modifier and Type Field and Description

static String NAMESPACE

Fields
Modifier and Type	Field and Description
`static String`	`NAMESPACE`

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Element`	`asXMLElement(Document document)` Takes the entire object hierarchy and produces an XML DOM tree.
`Element`	`asXMLElement(Document document, Element Channel_element)` Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`List<Annotation>`	`copyLinkedAnnotationList()`
`AcquisitionMode`	`getAcquisitionMode()`
`Color`	`getColor()`
`ContrastMethod`	`getContrastMethod()`
`DetectorSettings`	`getDetectorSettings()`
`Length`	`getEmissionWavelength()`
`static String`	`getEmissionWavelengthUnitXsdDefault()`
`Length`	`getExcitationWavelength()`
`static String`	`getExcitationWavelengthUnitXsdDefault()`
`String`	`getFluor()`
`String`	`getID()`
`IlluminationType`	`getIlluminationType()`
`LightPath`	`getLightPath()`
`LightSourceSettings`	`getLightSourceSettings()`
`Annotation`	`getLinkedAnnotation(int index)`
`FilterSet`	`getLinkedFilterSet()`
`String`	`getName()`
`Double`	`getNDFilter()`
`Length`	`getPinholeSize()`
`static String`	`getPinholeSizeUnitXsdDefault()`
`Pixels`	`getPixels()`
`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(String fluor)`
`void`	`setID(String id)`
`void`	`setIlluminationType(IlluminationType illuminationType)`
`void`	`setLightPath(LightPath lightPath)`
`void`	`setLightSourceSettings(LightSourceSettings lightSourceSettings)`
`Annotation`	`setLinkedAnnotation(int index, Annotation o)`
`void`	`setName(String name)`
`void`	`setNDFilter(Double ndFilter)`
`void`	`setPinholeSize(Length pinholeSize)`
`void`	`setPixels(Pixels pixels_BackReference)`
`void`	`setPockelCellSetting(Integer pockelCellSetting)`
`void`	`setSamplesPerPixel(PositiveInteger samplesPerPixel)`
`int`	`sizeOfLinkedAnnotationList()`
`boolean`	`unlinkAnnotation(Annotation o)`
`void`	`unlinkFilterSet(FilterSet o)`
`void`	`update(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 Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Channel
```
public Channel()
```
    Default constructor.
  - Channel
```
public Channel(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 Detail
  - update
```
public void update(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 String getID()
```
  - setID
```
public void setID(String id)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(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 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 String getExcitationWavelengthUnitXsdDefault()
```
  - getEmissionWavelength
```
public Length getEmissionWavelength()
```
  - setEmissionWavelength
```
public void setEmissionWavelength(Length emissionWavelength)
```
  - getEmissionWavelengthUnitXsdDefault
```
public static String getEmissionWavelengthUnitXsdDefault()
```
  - getFluor
```
public String getFluor()
```
  - setFluor
```
public void setFluor(String fluor)
```
  - getNDFilter
```
public Double getNDFilter()
```
  - setNDFilter
```
public void setNDFilter(Double ndFilter)
```
  - getPockelCellSetting
```
public Integer getPockelCellSetting()
```
  - setPockelCellSetting
```
public void setPockelCellSetting(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 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 Element asXMLElement(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 Element asXMLElement(Document document,
                            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 Detail

NAMESPACE

Constructor Detail

Channel

Channel

Channel

Method Detail

update

link

getID

setID

getName

setName

getSamplesPerPixel

setSamplesPerPixel

getIlluminationType

setIlluminationType

getPinholeSize

setPinholeSize

getPinholeSizeUnitXsdDefault

getAcquisitionMode

setAcquisitionMode

getContrastMethod

setContrastMethod

getExcitationWavelength

setExcitationWavelength

getExcitationWavelengthUnitXsdDefault

getEmissionWavelength

setEmissionWavelength

getEmissionWavelengthUnitXsdDefault

getFluor

setFluor

getNDFilter

setNDFilter

getPockelCellSetting

setPockelCellSetting

getColor

setColor

getLightSourceSettings

setLightSourceSettings

getDetectorSettings

setDetectorSettings

getLinkedFilterSet

linkFilterSet

unlinkFilterSet

sizeOfLinkedAnnotationList

copyLinkedAnnotationList

getLinkedAnnotation

setLinkedAnnotation

linkAnnotation

unlinkAnnotation

getLightPath

setLightPath

getPixels

setPixels

asXMLElement

asXMLElement