ome.xml.model

Class FilterSet

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.ManufacturerSpec

ome.xml.model.FilterSet

All Implemented Interfaces:

OMEModelObject

public class FilterSet
extends ManufacturerSpec

Field Summary

Fields

Modifier and Type	Field and Description
private List<Channel>	channels
private Dichroic	dichroic
private List<Filter>	emissionFilterLinks
private List<Filter>	excitationFilterLinks
private String	id
private Instrument	instrument
private static org.slf4j.Logger	LOGGER Logger for this class.
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
FilterSet() Default constructor.
FilterSet(Element element, OMEModel model) Constructs FilterSet recursively from an XML DOM tree.
FilterSet(FilterSet 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 FilterSet_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
List<Channel>	copyLinkedChannelList()
List<Filter>	copyLinkedEmissionFilterList()
List<Filter>	copyLinkedExcitationFilterList()
String	getID()
Instrument	getInstrument()
Channel	getLinkedChannel(int index)
Dichroic	getLinkedDichroic()
Filter	getLinkedEmissionFilter(int index)
Filter	getLinkedExcitationFilter(int index)
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
boolean	linkChannel(Channel o)
void	linkDichroic(Dichroic o)
boolean	linkEmissionFilter(Filter o)
boolean	linkExcitationFilter(Filter o)
void	setID(String id)
void	setInstrument(Instrument instrument_BackReference)
Channel	setLinkedChannel(int index, Channel o)
Filter	setLinkedEmissionFilter(int index, Filter o)
Filter	setLinkedExcitationFilter(int index, Filter o)
int	sizeOfLinkedChannelList()
int	sizeOfLinkedEmissionFilterList()
int	sizeOfLinkedExcitationFilterList()
boolean	unlinkChannel(Channel o)
void	unlinkDichroic(Dichroic o)
boolean	unlinkEmissionFilter(Filter o)
boolean	unlinkExcitationFilter(Filter o)
void	update(Element element, OMEModel model) Updates FilterSet 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

LOGGER

private static final org.slf4j.Logger LOGGER

Logger for this class.

id

private String id

excitationFilterLinks

private List<Filter> excitationFilterLinks

dichroic

private Dichroic dichroic

emissionFilterLinks

private List<Filter> emissionFilterLinks

channels

private List<Channel> channels

instrument

private Instrument instrument

Constructor Detail

FilterSet

public FilterSet()

Default constructor.

FilterSet

public FilterSet(Element element,
         OMEModel model)
          throws EnumerationException

Constructs FilterSet 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.

FilterSet

public FilterSet(FilterSet orig)

Copy constructor.

Method Detail

update

public void update(Element element,
          OMEModel model)
            throws EnumerationException

Updates FilterSet 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.

getID

public String getID()

setID

public void setID(String id)

sizeOfLinkedExcitationFilterList

public int sizeOfLinkedExcitationFilterList()

copyLinkedExcitationFilterList

public List<Filter> copyLinkedExcitationFilterList()

getLinkedExcitationFilter

public Filter getLinkedExcitationFilter(int index)

setLinkedExcitationFilter

public Filter setLinkedExcitationFilter(int index,
                               Filter o)

linkExcitationFilter

public boolean linkExcitationFilter(Filter o)

unlinkExcitationFilter

public boolean unlinkExcitationFilter(Filter o)

getLinkedDichroic

public Dichroic getLinkedDichroic()

linkDichroic

public void linkDichroic(Dichroic o)

unlinkDichroic

public void unlinkDichroic(Dichroic o)

sizeOfLinkedEmissionFilterList

public int sizeOfLinkedEmissionFilterList()

copyLinkedEmissionFilterList

public List<Filter> copyLinkedEmissionFilterList()

getLinkedEmissionFilter

public Filter getLinkedEmissionFilter(int index)

setLinkedEmissionFilter

public Filter setLinkedEmissionFilter(int index,
                             Filter o)

linkEmissionFilter

public boolean linkEmissionFilter(Filter o)

unlinkEmissionFilter

public boolean unlinkEmissionFilter(Filter o)

sizeOfLinkedChannelList

public int sizeOfLinkedChannelList()

copyLinkedChannelList

public List<Channel> copyLinkedChannelList()

getLinkedChannel

public Channel getLinkedChannel(int index)

setLinkedChannel

public Channel setLinkedChannel(int index,
                       Channel o)

linkChannel

public boolean linkChannel(Channel o)

unlinkChannel

public boolean unlinkChannel(Channel o)

getInstrument

public Instrument getInstrument()

setInstrument

public void setInstrument(Instrument instrument_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

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 FilterSet_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.

FilterSet_element - Element from the subclass. If null a new element will be created of this class.

Returns:

element populated with properties from this class.