Filter (Bio-Formats API)

java.lang.Object
- ome.xml.model.AbstractOMEModelObject
- - ome.xml.model.ManufacturerSpec
  - - ome.xml.model.Filter

All Implemented Interfaces:: OMEModelObject

public class Filter
extends ManufacturerSpec

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
`Filter()` Default constructor.
`Filter(Element element, OMEModel model)` Constructs Filter recursively from an XML DOM tree.
`Filter(Filter orig)` Copy constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Element`	`asXMLElement(Document document)` Takes the entire object hierarchy and produces an XML DOM tree.
`protected Element`	`asXMLElement(Document document, Element Filter_element)` Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`List<FilterSet>`	`copyLinkedFilterSetEmissionFilterList()`
`List<FilterSet>`	`copyLinkedFilterSetExcitationFilterList()`
`List<LightPath>`	`copyLinkedLightPathEmissionFilterList()`
`List<LightPath>`	`copyLinkedLightPathExcitationFilterList()`
`String`	`getFilterWheel()`
`String`	`getID()`
`Instrument`	`getInstrument()`
`FilterSet`	`getLinkedFilterSetEmissionFilter(int index)`
`FilterSet`	`getLinkedFilterSetExcitationFilter(int index)`
`LightPath`	`getLinkedLightPathEmissionFilter(int index)`
`LightPath`	`getLinkedLightPathExcitationFilter(int index)`
`TransmittanceRange`	`getTransmittanceRange()`
`FilterType`	`getType()`
`boolean`	`link(Reference reference, OMEModelObject o)` Link a given OME model object to this model object.
`boolean`	`linkFilterSetEmissionFilter(FilterSet o)`
`boolean`	`linkFilterSetExcitationFilter(FilterSet o)`
`boolean`	`linkLightPathEmissionFilter(LightPath o)`
`boolean`	`linkLightPathExcitationFilter(LightPath o)`
`void`	`setFilterWheel(String filterWheel)`
`void`	`setID(String id)`
`void`	`setInstrument(Instrument instrument_BackReference)`
`FilterSet`	`setLinkedFilterSetEmissionFilter(int index, FilterSet o)`
`FilterSet`	`setLinkedFilterSetExcitationFilter(int index, FilterSet o)`
`LightPath`	`setLinkedLightPathEmissionFilter(int index, LightPath o)`
`LightPath`	`setLinkedLightPathExcitationFilter(int index, LightPath o)`
`void`	`setTransmittanceRange(TransmittanceRange transmittanceRange)`
`void`	`setType(FilterType type)`
`int`	`sizeOfLinkedFilterSetEmissionFilterList()`
`int`	`sizeOfLinkedFilterSetExcitationFilterList()`
`int`	`sizeOfLinkedLightPathEmissionFilterList()`
`int`	`sizeOfLinkedLightPathExcitationFilterList()`
`boolean`	`unlinkFilterSetEmissionFilter(FilterSet o)`
`boolean`	`unlinkFilterSetExcitationFilter(FilterSet o)`
`boolean`	`unlinkLightPathEmissionFilter(LightPath o)`
`boolean`	`unlinkLightPathExcitationFilter(LightPath o)`
`void`	`update(Element element, OMEModel model)` Updates Filter recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.ManufacturerSpec
getLotNumber, getManufacturer, getModel, getSerialNumber, setLotNumber, setManufacturer, setModel, setSerialNumber

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
  - Filter
```
public Filter()
```
    Default constructor.
  - Filter
```
public Filter(Element element,
      OMEModel model)
       throws EnumerationException
```
    Constructs Filter 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.
  - Filter
```
public Filter(Filter orig)
```
    Copy constructor.
- Method Detail
  - update
```
public void update(Element element,
          OMEModel model)
            throws EnumerationException
```
    Updates Filter 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 ManufacturerSpec
    
    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 ManufacturerSpec
    
    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.
  - getFilterWheel
```
public String getFilterWheel()
```
  - setFilterWheel
```
public void setFilterWheel(String filterWheel)
```
  - getType
```
public FilterType getType()
```
  - setType
```
public void setType(FilterType type)
```
  - getID
```
public String getID()
```
  - setID
```
public void setID(String id)
```
  - getTransmittanceRange
```
public TransmittanceRange getTransmittanceRange()
```
  - setTransmittanceRange
```
public void setTransmittanceRange(TransmittanceRange transmittanceRange)
```
  - getInstrument
```
public Instrument getInstrument()
```
  - setInstrument
```
public void setInstrument(Instrument instrument_BackReference)
```
  - sizeOfLinkedFilterSetExcitationFilterList
```
public int sizeOfLinkedFilterSetExcitationFilterList()
```
  - copyLinkedFilterSetExcitationFilterList
```
public List<FilterSet> copyLinkedFilterSetExcitationFilterList()
```
  - getLinkedFilterSetExcitationFilter
```
public FilterSet getLinkedFilterSetExcitationFilter(int index)
```
  - setLinkedFilterSetExcitationFilter
```
public FilterSet setLinkedFilterSetExcitationFilter(int index,
                                           FilterSet o)
```
  - linkFilterSetExcitationFilter
```
public boolean linkFilterSetExcitationFilter(FilterSet o)
```
  - unlinkFilterSetExcitationFilter
```
public boolean unlinkFilterSetExcitationFilter(FilterSet o)
```
  - sizeOfLinkedFilterSetEmissionFilterList
```
public int sizeOfLinkedFilterSetEmissionFilterList()
```
  - copyLinkedFilterSetEmissionFilterList
```
public List<FilterSet> copyLinkedFilterSetEmissionFilterList()
```
  - getLinkedFilterSetEmissionFilter
```
public FilterSet getLinkedFilterSetEmissionFilter(int index)
```
  - setLinkedFilterSetEmissionFilter
```
public FilterSet setLinkedFilterSetEmissionFilter(int index,
                                         FilterSet o)
```
  - linkFilterSetEmissionFilter
```
public boolean linkFilterSetEmissionFilter(FilterSet o)
```
  - unlinkFilterSetEmissionFilter
```
public boolean unlinkFilterSetEmissionFilter(FilterSet o)
```
  - sizeOfLinkedLightPathExcitationFilterList
```
public int sizeOfLinkedLightPathExcitationFilterList()
```
  - copyLinkedLightPathExcitationFilterList
```
public List<LightPath> copyLinkedLightPathExcitationFilterList()
```
  - getLinkedLightPathExcitationFilter
```
public LightPath getLinkedLightPathExcitationFilter(int index)
```
  - setLinkedLightPathExcitationFilter
```
public LightPath setLinkedLightPathExcitationFilter(int index,
                                           LightPath o)
```
  - linkLightPathExcitationFilter
```
public boolean linkLightPathExcitationFilter(LightPath o)
```
  - unlinkLightPathExcitationFilter
```
public boolean unlinkLightPathExcitationFilter(LightPath o)
```
  - sizeOfLinkedLightPathEmissionFilterList
```
public int sizeOfLinkedLightPathEmissionFilterList()
```
  - copyLinkedLightPathEmissionFilterList
```
public List<LightPath> copyLinkedLightPathEmissionFilterList()
```
  - getLinkedLightPathEmissionFilter
```
public LightPath getLinkedLightPathEmissionFilter(int index)
```
  - setLinkedLightPathEmissionFilter
```
public LightPath setLinkedLightPathEmissionFilter(int index,
                                         LightPath o)
```
  - linkLightPathEmissionFilter
```
public boolean linkLightPathEmissionFilter(LightPath o)
```
  - unlinkLightPathEmissionFilter
```
public boolean unlinkLightPathEmissionFilter(LightPath o)
```
  - 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
    
    Overrides:
    
    asXMLElement in class ManufacturerSpec
    
    Parameters:
    document - Destination document for element creation, etc.
    
    Returns:
    XML DOM tree root element for this model object.
  - asXMLElement
```
protected Element asXMLElement(Document document,
                   Element Filter_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 ManufacturerSpec
    
    Parameters:
    document - Destination document for element creation, etc.
    Filter_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 Filter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ome.xml.model.ManufacturerSpec

Methods inherited from class ome.xml.model.AbstractOMEModelObject

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

Constructor Detail

Filter

Filter

Filter

Method Detail

update

link

getFilterWheel

setFilterWheel

getType

setType

getID

setID

getTransmittanceRange

setTransmittanceRange

getInstrument

setInstrument

sizeOfLinkedFilterSetExcitationFilterList

copyLinkedFilterSetExcitationFilterList

getLinkedFilterSetExcitationFilter

setLinkedFilterSetExcitationFilter

linkFilterSetExcitationFilter

unlinkFilterSetExcitationFilter

sizeOfLinkedFilterSetEmissionFilterList

copyLinkedFilterSetEmissionFilterList

getLinkedFilterSetEmissionFilter

setLinkedFilterSetEmissionFilter

linkFilterSetEmissionFilter

unlinkFilterSetEmissionFilter

sizeOfLinkedLightPathExcitationFilterList

copyLinkedLightPathExcitationFilterList

getLinkedLightPathExcitationFilter

setLinkedLightPathExcitationFilter

linkLightPathExcitationFilter

unlinkLightPathExcitationFilter

sizeOfLinkedLightPathEmissionFilterList

copyLinkedLightPathEmissionFilterList

getLinkedLightPathEmissionFilter

setLinkedLightPathEmissionFilter

linkLightPathEmissionFilter

unlinkLightPathEmissionFilter

asXMLElement

asXMLElement