Package ome.xml.model
Class Filter
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.ManufacturerSpec
ome.xml.model.Filter
- All Implemented Interfaces:
OMEModelObject
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionasXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.asXMLElement(Document document, Element Filter_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.getID()getLinkedAnnotation(int index) getLinkedFilterSetEmissionFilter(int index) getLinkedFilterSetExcitationFilter(int index) getLinkedLightPathEmissionFilter(int index) getLinkedLightPathExcitationFilter(int index) getType()booleanlink(Reference reference, OMEModelObject o) Link a given OME model object to this model object.booleanbooleanbooleanbooleanbooleanvoidsetFilterWheel(String filterWheel) voidvoidsetInstrument(Instrument instrument_BackReference) setLinkedAnnotation(int index, Annotation o) setLinkedFilterSetEmissionFilter(int index, FilterSet o) setLinkedFilterSetExcitationFilter(int index, FilterSet o) setLinkedLightPathEmissionFilter(int index, LightPath o) setLinkedLightPathExcitationFilter(int index, LightPath o) voidsetTransmittanceRange(TransmittanceRange transmittanceRange) voidsetType(FilterType type) intintintintintbooleanbooleanbooleanbooleanbooleanvoidUpdates Filter recursively from an XML DOM tree.Methods inherited from class ome.xml.model.ManufacturerSpec
getLotNumber, getManufacturer, getModel, getSerialNumber, setLotNumber, setManufacturer, setModel, setSerialNumberMethods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
- See Also:
-
-
Constructor Details
-
Filter
public Filter()Default constructor. -
Filter
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
Copy constructor.
-
-
Method Details
-
update
Updates Filter recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
updatein interfaceOMEModelObject- Overrides:
updatein classManufacturerSpec- 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
Description copied from interface:OMEModelObjectLink a given OME model object to this model object.- Specified by:
linkin interfaceOMEModelObject- Overrides:
linkin classManufacturerSpec- Parameters:
reference- The type qualifier for the reference. This should be the corresponding reference type foro. If, for example,ois of typeImage,referenceMUST be of typeImageRef.o- Model object to link to.- Returns:
trueif this model object was able to handle the reference,falseotherwise.
-
getType
-
setType
-
getFilterWheel
-
setFilterWheel
-
getID
-
setID
-
getTransmittanceRange
-
setTransmittanceRange
-
sizeOfLinkedAnnotationList
public int sizeOfLinkedAnnotationList() -
copyLinkedAnnotationList
-
getLinkedAnnotation
-
setLinkedAnnotation
-
linkAnnotation
-
unlinkAnnotation
-
getInstrument
-
setInstrument
-
sizeOfLinkedFilterSetExcitationFilterList
public int sizeOfLinkedFilterSetExcitationFilterList() -
copyLinkedFilterSetExcitationFilterList
-
getLinkedFilterSetExcitationFilter
-
setLinkedFilterSetExcitationFilter
-
linkFilterSetExcitationFilter
-
unlinkFilterSetExcitationFilter
-
sizeOfLinkedFilterSetEmissionFilterList
public int sizeOfLinkedFilterSetEmissionFilterList() -
copyLinkedFilterSetEmissionFilterList
-
getLinkedFilterSetEmissionFilter
-
setLinkedFilterSetEmissionFilter
-
linkFilterSetEmissionFilter
-
unlinkFilterSetEmissionFilter
-
sizeOfLinkedLightPathExcitationFilterList
public int sizeOfLinkedLightPathExcitationFilterList() -
copyLinkedLightPathExcitationFilterList
-
getLinkedLightPathExcitationFilter
-
setLinkedLightPathExcitationFilter
-
linkLightPathExcitationFilter
-
unlinkLightPathExcitationFilter
-
sizeOfLinkedLightPathEmissionFilterList
public int sizeOfLinkedLightPathEmissionFilterList() -
copyLinkedLightPathEmissionFilterList
-
getLinkedLightPathEmissionFilter
-
setLinkedLightPathEmissionFilter
-
linkLightPathEmissionFilter
-
unlinkLightPathEmissionFilter
-
asXMLElement
Description copied from interface:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Overrides:
asXMLElementin classManufacturerSpec- Parameters:
document- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
Description copied from class:AbstractOMEModelObjectTakes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.- Overrides:
asXMLElementin classManufacturerSpec- Parameters:
document- Destination document for element creation, etc.Filter_element- Element from the subclass. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-