Filter (OMERO API)

java.lang.Object
- ome.model.acquisition.Filter

All Implemented Interfaces:

Serializable, IAnnotated, IMutable, IObject, Filterable
```
@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class Filter
extends Object
implements Serializable, IObject, IMutable, IAnnotated
```
These filter definitions are used by the security system to eliminate non-readable objects from queries. The regular user does not need to worry about them, as they will be injected directly into the SQL (not HQL)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Filter.Details

Nested Classes
Modifier and Type	Class and Description
`static class`	`Filter.Details`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`_dynamicFields`
`protected boolean`	`_loaded`
`protected Set<FilterAnnotationLink>`	`annotationLinks`
`static String`	`ANNOTATIONLINKS`
`static String`	`ANNOTATIONLINKSCOUNTPEROWNER`
`protected Details`	`details`
`static String`	`DETAILS`
`protected Set<FilterSetEmissionFilterLink>`	`emissionFilterLink`
`static String`	`EMISSIONFILTERLINK`
`static String`	`EMISSIONFILTERLINKCOUNTPEROWNER`
`static String`	`EVENT_FILTER`
`static String`	`EVENT_FILTER_ANNOTATIONLINKS`
`static String`	`EVENT_FILTER_EMISSIONFILTERLINK`
`static String`	`EVENT_FILTER_EXCITATIONFILTERLINK`
`protected Set<FilterSetExcitationFilterLink>`	`excitationFilterLink`
`static String`	`EXCITATIONFILTERLINK`
`static String`	`EXCITATIONFILTERLINKCOUNTPEROWNER`
`static Set<String>`	`FIELDS`
`protected String`	`filterWheel`
`static String`	`FILTERWHEEL`
`static String`	`GROUP_FILTER`
`static String`	`GROUP_FILTER_ANNOTATIONLINKS`
`static String`	`GROUP_FILTER_EMISSIONFILTERLINK`
`static String`	`GROUP_FILTER_EXCITATIONFILTERLINK`
`protected Long`	`id`
`static String`	`ID`
`protected Instrument`	`instrument`
`static String`	`INSTRUMENT`
`protected String`	`lotNumber`
`static String`	`LOTNUMBER`
`protected String`	`manufacturer`
`static String`	`MANUFACTURER`
`protected String`	`model`
`static String`	`MODEL`
`static String`	`OWNER_FILTER`
`static String`	`OWNER_FILTER_ANNOTATIONLINKS`
`static String`	`OWNER_FILTER_EMISSIONFILTERLINK`
`static String`	`OWNER_FILTER_EXCITATIONFILTERLINK`
`static String`	`PERMS_FILTER`
`static String`	`PERMS_FILTER_ANNOTATIONLINKS`
`static String`	`PERMS_FILTER_EMISSIONFILTERLINK`
`static String`	`PERMS_FILTER_EXCITATIONFILTERLINK`
`protected String`	`serialNumber`
`static String`	`SERIALNUMBER`
`protected TransmittanceRange`	`transmittanceRange`
`static String`	`TRANSMITTANCERANGE`
`protected FilterType`	`type`
`static String`	`TYPE`
`protected Integer`	`version`
`static String`	`VERSION`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Filter()`
	`Filter(Instrument _instrument)`
`protected`	`Filter(Long id)`
	`Filter(Long id, boolean loaded)` Main constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter __filter)`
`void`	`addFilterAnnotationLink(FilterAnnotationLink target)` use instead of setAnnotationLinks .
`void`	`addFilterAnnotationLink(FilterAnnotationLink link, boolean bothSides)` Adds a ome.model.annotations.FilterAnnotationLink to annotationLinks, allowing for recursion -- whether or not addFilterAnnotationLink will be called on the addition if it is loaded
`void`	`addFilterAnnotationLinkSet(Collection<FilterAnnotationLink> targets)` use like addFilterAnnotationLink.
`void`	`addFilterSetEmissionFilterLink(FilterSetEmissionFilterLink target)` use instead of setEmissionFilterLink .
`void`	`addFilterSetEmissionFilterLink(FilterSetEmissionFilterLink link, boolean bothSides)` Adds a ome.model.acquisition.FilterSetEmissionFilterLink to emissionFilterLink, allowing for recursion -- whether or not addFilterSetEmissionFilterLink will be called on the addition if it is loaded
`void`	`addFilterSetEmissionFilterLinkSet(Collection<FilterSetEmissionFilterLink> targets)` use like addFilterSetEmissionFilterLink.
`void`	`addFilterSetExcitationFilterLink(FilterSetExcitationFilterLink target)` use instead of setExcitationFilterLink .
`void`	`addFilterSetExcitationFilterLink(FilterSetExcitationFilterLink link, boolean bothSides)` Adds a ome.model.acquisition.FilterSetExcitationFilterLink to excitationFilterLink, allowing for recursion -- whether or not addFilterSetExcitationFilterLink will be called on the addition if it is loaded
`void`	`addFilterSetExcitationFilterLinkSet(Collection<FilterSetExcitationFilterLink> targets)` use like addFilterSetExcitationFilterLink.
`void`	`clearAnnotationLinks()` clears the set.
`void`	`clearEmissionFilterLinks()` clears the set.
`void`	`clearExcitationFilterLinks()` clears the set.
`<E> List<E>`	`collectAnnotationLinks(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.annotations.FilterAnnotationLink while collecting the results.
`<E> List<E>`	`collectEmissionFilterLink(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.acquisition.FilterSetEmissionFilterLink while collecting the results.
`<E> List<E>`	`collectExcitationFilterLink(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.acquisition.FilterSetExcitationFilterLink while collecting the results.
`<E> List<E>`	`eachLinkedAnnotation(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results.
`<E> List<E>`	`eachLinkedEmissionFilter(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.acquisition.FilterSet while collecting the results.
`<E> List<E>`	`eachLinkedExcitationFilter(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.acquisition.FilterSet while collecting the results.
`protected void`	`errorIfUnloaded()`
`Set<String>`	`fields()` returns a Set of field names that belong to this class
`Set<FilterAnnotationLink>`	`findFilterAnnotationLink(Annotation target)` find all ome.model.annotations.FilterAnnotationLink which have the argument as their child.
`Set<FilterSetEmissionFilterLink>`	`findFilterSetEmissionFilterLink(FilterSet target)` find all ome.model.acquisition.FilterSetEmissionFilterLink which have the argument as their parent.
`Set<FilterSetExcitationFilterLink>`	`findFilterSetExcitationFilterLink(FilterSet target)` find all ome.model.acquisition.FilterSetExcitationFilterLink which have the argument as their parent.
`protected Set<FilterAnnotationLink>`	`getAnnotationLinks()` returns annotationLinks .
`Map<Long,Long>`	`getAnnotationLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.annotations.FilterAnnotationLink that a user has.
`Details`	`getDetails()` The details of this object correspond to low-level system information.
`protected Set<FilterSetEmissionFilterLink>`	`getEmissionFilterLink()` returns emissionFilterLink .
`Map<Long,Long>`	`getEmissionFilterLinkCountPerOwner()` If fetched, returns the count(*) of ome.model.acquisition.FilterSetEmissionFilterLink that a user has.
`protected Set<FilterSetExcitationFilterLink>`	`getExcitationFilterLink()` returns excitationFilterLink .
`Map<Long,Long>`	`getExcitationFilterLinkCountPerOwner()` If fetched, returns the count(*) of ome.model.acquisition.FilterSetExcitationFilterLink that a user has.
`String`	`getFilterWheel()` Simple field ome.model.acquisition.Filter.filterWheel (java.lang.String)
`GraphHolder`	`getGraphHolder()` retrieves the `GraphHolder` for this entity.
`Long`	`getId()` The DB unique identifier for this object.
`Instrument`	`getInstrument()` Many-to-one field ome.model.acquisition.Filter.instrument (ome.model.acquisition.Instrument)
`String`	`getLotNumber()` Simple field ome.model.acquisition.Filter.lotNumber (java.lang.String)
`String`	`getManufacturer()` Simple field ome.model.acquisition.Filter.manufacturer (java.lang.String)
`String`	`getModel()` Simple field ome.model.acquisition.Filter.model (java.lang.String)
`String`	`getSerialNumber()` Simple field ome.model.acquisition.Filter.serialNumber (java.lang.String)
`TransmittanceRange`	`getTransmittanceRange()` Many-to-one field ome.model.acquisition.Filter.transmittanceRange (ome.model.acquisition.TransmittanceRange)
`FilterType`	`getType()` Many-to-one field ome.model.acquisition.Filter.type (ome.model.enums.FilterType)
`Integer`	`getVersion()` This version number is controlled by the database for optimisitic locking.
`boolean`	`isLoaded()` transient field (not stored in the DB) which specifies whether this object has been loaded from the DB or is only a wrapper around the ID.
`boolean`	`isValid()` calls the class-specific validator for this instance and returns the value from `Validation.isValid()`
`Iterator<FilterAnnotationLink>`	`iterateAnnotationLinks()` should be used rather than accessing the annotationLinks set directly.
`Iterator<FilterSetEmissionFilterLink>`	`iterateEmissionFilterLink()` should be used rather than accessing the emissionFilterLink set directly.
`Iterator<FilterSetExcitationFilterLink>`	`iterateExcitationFilterLink()` should be used rather than accessing the excitationFilterLink set directly.
`FilterAnnotationLink`	`linkAnnotation(Annotation addition)` Adds a ome.model.annotations.FilterAnnotationLink to annotationLinks .
`Iterator<Annotation>`	`linkedAnnotationIterator()` provides an iterator over the parent values of the annotationLinks.
`List<Annotation>`	`linkedAnnotationList()` produces a `List`-copy of the underlying collection.
`Iterator<FilterSet>`	`linkedEmissionFilterIterator()` provides an iterator over the child values of the emissionFilterLink.
`List<FilterSet>`	`linkedEmissionFilterList()` produces a `List`-copy of the underlying collection.
`Iterator<FilterSet>`	`linkedExcitationFilterIterator()` provides an iterator over the child values of the excitationFilterLink.
`List<FilterSet>`	`linkedExcitationFilterList()` produces a `List`-copy of the underlying collection.
`FilterSetEmissionFilterLink`	`linkEmissionFilter(FilterSet addition)` Adds a ome.model.acquisition.FilterSetEmissionFilterLink to emissionFilterLink .
`FilterSetExcitationFilterLink`	`linkExcitationFilter(FilterSet addition)` Adds a ome.model.acquisition.FilterSetExcitationFilterLink to excitationFilterLink .
`Filter`	`newInstance()`
`Filter`	`proxy()`
`void`	`putAt(String field, Object value)` stores a value in this instance.
`void`	`removeFilterAnnotationLink(FilterAnnotationLink target)` removes a single element from this set and makes the inverse call on ome.model.annotations.FilterAnnotationLink
`void`	`removeFilterAnnotationLink(FilterAnnotationLink link, boolean bothSides)` removes the given FilterAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkFilter again if loaded.
`void`	`removeFilterAnnotationLinkSet(Collection<FilterAnnotationLink> targets)` use like removeFilterAnnotationLink
`void`	`removeFilterSetEmissionFilterLink(FilterSetEmissionFilterLink target)` removes a single element from this set and makes the inverse call on ome.model.acquisition.FilterSetEmissionFilterLink
`void`	`removeFilterSetEmissionFilterLink(FilterSetEmissionFilterLink link, boolean bothSides)` removes the given FilterSetEmissionFilterLink from emissionFilterLink, allowing for recursion -- whether or not the removal will call unlinkFilter again if loaded.
`void`	`removeFilterSetEmissionFilterLinkSet(Collection<FilterSetEmissionFilterLink> targets)` use like removeFilterSetEmissionFilterLink
`void`	`removeFilterSetExcitationFilterLink(FilterSetExcitationFilterLink target)` removes a single element from this set and makes the inverse call on ome.model.acquisition.FilterSetExcitationFilterLink
`void`	`removeFilterSetExcitationFilterLink(FilterSetExcitationFilterLink link, boolean bothSides)` removes the given FilterSetExcitationFilterLink from excitationFilterLink, allowing for recursion -- whether or not the removal will call unlinkFilter again if loaded.
`void`	`removeFilterSetExcitationFilterLinkSet(Collection<FilterSetExcitationFilterLink> targets)` use like removeFilterSetExcitationFilterLink
`Object`	`retrieve(String field)` retrieves a value from this instance.
`protected void`	`setAnnotationLinks(Set<FilterAnnotationLink> annotationLinks)` setter for annotationLinks should be avoided.
`protected void`	`setAnnotationLinksCountPerOwner(Map<Long,Long> map)`
`protected void`	`setDetails(Details details)` Use the `Details.copy(ome.model.internal.Details)` or `Details.shallowCopy(ome.model.internal.Details)` methods to set the `Filter.Details` instance instead.
`protected void`	`setEmissionFilterLink(Set<FilterSetEmissionFilterLink> emissionFilterLink)` setter for emissionFilterLink should be avoided.
`protected void`	`setEmissionFilterLinkCountPerOwner(Map<Long,Long> map)`
`protected void`	`setExcitationFilterLink(Set<FilterSetExcitationFilterLink> excitationFilterLink)` setter for excitationFilterLink should be avoided.
`protected void`	`setExcitationFilterLinkCountPerOwner(Map<Long,Long> map)`
`void`	`setFilterWheel(String filterWheel)`
`void`	`setId(Long id)` usually unneeded.
`void`	`setInstrument(Instrument instrument)`
`void`	`setLotNumber(String lotNumber)`
`void`	`setManufacturer(String manufacturer)`
`void`	`setModel(String model)`
`void`	`setSerialNumber(String serialNumber)`
`void`	`setTransmittanceRange(TransmittanceRange transmittanceRange)`
`void`	`setType(FilterType type)`
`void`	`setVersion(Integer version)` use with caution.
`int`	`sizeOfAnnotationLinks()` returns the size of annotationLinks.
`int`	`sizeOfEmissionFilterLink()` returns the size of emissionFilterLink.
`int`	`sizeOfExcitationFilterLink()` returns the size of excitationFilterLink.
`protected void`	`throwNullCollectionException(String propertyName)`
`String`	`toString()`
`void`	`unlinkAnnotation(Annotation removal)` unlinks all ome.model.annotations.Annotation instances from this instance.
`void`	`unlinkEmissionFilter(FilterSet removal)` unlinks all ome.model.acquisition.FilterSet instances from this instance.
`void`	`unlinkExcitationFilter(FilterSet removal)` unlinks all ome.model.acquisition.FilterSet instances from this instance.
`void`	`unload()` set the loaded field to false, and set all non-ID fields to null.
`Collection<FilterAnnotationLink>`	`unmodifiableAnnotationLinks()` Returns an unmodifiable collection-view
`Collection<FilterSetEmissionFilterLink>`	`unmodifiableEmissionFilterLink()` Returns an unmodifiable collection-view
`Collection<FilterSetExcitationFilterLink>`	`unmodifiableExcitationFilterLink()` Returns an unmodifiable collection-view
`Validation`	`validate()` calls the class-specific validator for this instance and returns the `Validation` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - OWNER_FILTER
```
public static final String OWNER_FILTER
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER
```
public static final String GROUP_FILTER
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER
```
public static final String EVENT_FILTER
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER
```
public static final String PERMS_FILTER
```
    See Also:
    
    Constant Field Values
  - ID
```
public static final String ID
```
    See Also:
    
    Constant Field Values
  - id
```
protected Long id
```
  - VERSION
```
public static final String VERSION
```
    See Also:
    
    Constant Field Values
  - version
```
protected Integer version
```
  - manufacturer
```
protected String manufacturer
```
  - model
```
protected String model
```
  - lotNumber
```
protected String lotNumber
```
  - serialNumber
```
protected String serialNumber
```
  - filterWheel
```
protected String filterWheel
```
  - type
```
protected FilterType type
```
  - transmittanceRange
```
protected TransmittanceRange transmittanceRange
```
  - instrument
```
protected Instrument instrument
```
  - excitationFilterLink
```
protected Set<FilterSetExcitationFilterLink> excitationFilterLink
```
  - OWNER_FILTER_EXCITATIONFILTERLINK
```
public static final String OWNER_FILTER_EXCITATIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_EXCITATIONFILTERLINK
```
public static final String GROUP_FILTER_EXCITATIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_EXCITATIONFILTERLINK
```
public static final String EVENT_FILTER_EXCITATIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_EXCITATIONFILTERLINK
```
public static final String PERMS_FILTER_EXCITATIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - emissionFilterLink
```
protected Set<FilterSetEmissionFilterLink> emissionFilterLink
```
  - OWNER_FILTER_EMISSIONFILTERLINK
```
public static final String OWNER_FILTER_EMISSIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_EMISSIONFILTERLINK
```
public static final String GROUP_FILTER_EMISSIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_EMISSIONFILTERLINK
```
public static final String EVENT_FILTER_EMISSIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_EMISSIONFILTERLINK
```
public static final String PERMS_FILTER_EMISSIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - annotationLinks
```
protected Set<FilterAnnotationLink> annotationLinks
```
  - OWNER_FILTER_ANNOTATIONLINKS
```
public static final String OWNER_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_ANNOTATIONLINKS
```
public static final String GROUP_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_ANNOTATIONLINKS
```
public static final String EVENT_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_ANNOTATIONLINKS
```
public static final String PERMS_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - details
```
protected Details details
```
  - MANUFACTURER
```
public static final String MANUFACTURER
```
    See Also:
    
    Constant Field Values
  - MODEL
```
public static final String MODEL
```
    See Also:
    
    Constant Field Values
  - LOTNUMBER
```
public static final String LOTNUMBER
```
    See Also:
    
    Constant Field Values
  - SERIALNUMBER
```
public static final String SERIALNUMBER
```
    See Also:
    
    Constant Field Values
  - FILTERWHEEL
```
public static final String FILTERWHEEL
```
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final String TYPE
```
    See Also:
    
    Constant Field Values
  - TRANSMITTANCERANGE
```
public static final String TRANSMITTANCERANGE
```
    See Also:
    
    Constant Field Values
  - INSTRUMENT
```
public static final String INSTRUMENT
```
    See Also:
    
    Constant Field Values
  - EXCITATIONFILTERLINKCOUNTPEROWNER
```
public static final String EXCITATIONFILTERLINKCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - EXCITATIONFILTERLINK
```
public static final String EXCITATIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - EMISSIONFILTERLINKCOUNTPEROWNER
```
public static final String EMISSIONFILTERLINKCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - EMISSIONFILTERLINK
```
public static final String EMISSIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - ANNOTATIONLINKSCOUNTPEROWNER
```
public static final String ANNOTATIONLINKSCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - ANNOTATIONLINKS
```
public static final String ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - DETAILS
```
public static final String DETAILS
```
    See Also:
    
    Constant Field Values
  - FIELDS
```
public static final Set<String> FIELDS
```
  - _dynamicFields
```
protected Map<String,Object> _dynamicFields
```
  - _loaded
```
protected boolean _loaded
```
- Constructor Detail
  - Filter
```
public Filter()
```
  - Filter
```
protected Filter(Long id)
```
  - Filter
```
public Filter(Long id,
              boolean loaded)
```
    Main constructor.
  - Filter
```
public Filter(Instrument _instrument)
```
- Method Detail
  - getId
```
@DocumentId
public Long getId()
```
    The DB unique identifier for this object. You are not responsible for setting the id; however, it can be useful for creating "unloaded" versions of your objects. Each top-level entity contains an id field of type long. For all objects returned from the server, this value will be non-null, which doesn't necessarily hold for the other fields.
    
    Specified by:
    
    getId in interface IObject
    
    Returns:
    
    Long primary key. May be null.
  - setId
```
public void setId(Long id)
```
    Description copied from interface: IObject
    
    usually unneeded. Ids are managed by the backend.
    
    Specified by:
    
    setId in interface IObject
    
    Parameters:
    
    id - Long value for this id.
  - getVersion
```
public Integer getVersion()
```
    This version number is controlled by the database for optimisitic locking.
    
    Specified by:
    
    getVersion in interface IMutable
  - setVersion
```
public void setVersion(Integer version)
```
    Description copied from interface: IMutable
    
    use with caution. In general, the version should only be altered by the backend. In the best case, an exception will be thrown for a version not equal to the current DB value. In the worst (though rare) case, the new version could match the database, and override optimistic lock checks that are supposed to prevent data loss.
    
    Specified by:
    
    setVersion in interface IMutable
    
    Parameters:
    
    version - Value for this objects version.
  - getManufacturer
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getManufacturer()
```
    Simple field ome.model.acquisition.Filter.manufacturer (java.lang.String)
  - setManufacturer
```
public void setManufacturer(String manufacturer)
```
  - getModel
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getModel()
```
    Simple field ome.model.acquisition.Filter.model (java.lang.String)
  - setModel
```
public void setModel(String model)
```
  - getLotNumber
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getLotNumber()
```
    Simple field ome.model.acquisition.Filter.lotNumber (java.lang.String)
  - setLotNumber
```
public void setLotNumber(String lotNumber)
```
  - getSerialNumber
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getSerialNumber()
```
    Simple field ome.model.acquisition.Filter.serialNumber (java.lang.String)
  - setSerialNumber
```
public void setSerialNumber(String serialNumber)
```
  - getFilterWheel
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getFilterWheel()
```
    Simple field ome.model.acquisition.Filter.filterWheel (java.lang.String)
  - setFilterWheel
```
public void setFilterWheel(String filterWheel)
```
  - getType
```
public FilterType getType()
```
    Many-to-one field ome.model.acquisition.Filter.type (ome.model.enums.FilterType)
  - setType
```
public void setType(FilterType type)
```
  - getTransmittanceRange
```
public TransmittanceRange getTransmittanceRange()
```
    Many-to-one field ome.model.acquisition.Filter.transmittanceRange (ome.model.acquisition.TransmittanceRange)
  - setTransmittanceRange
```
public void setTransmittanceRange(TransmittanceRange transmittanceRange)
```
  - getInstrument
```
public Instrument getInstrument()
```
    Many-to-one field ome.model.acquisition.Filter.instrument (ome.model.acquisition.Instrument)
  - setInstrument
```
public void setInstrument(Instrument instrument)
```
  - getExcitationFilterLink
```
protected Set<FilterSetExcitationFilterLink> getExcitationFilterLink()
```
    returns excitationFilterLink . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.acquisition.Filter.excitationFilterLink (ome.model.acquisition.FilterSetExcitationFilterLink)
  - setExcitationFilterLink
```
protected void setExcitationFilterLink(Set<FilterSetExcitationFilterLink> excitationFilterLink)
```
    setter for excitationFilterLink should be avoided. Does not fulfill normal semantics.
  - sizeOfExcitationFilterLink
```
public int sizeOfExcitationFilterLink()
```
    returns the size of excitationFilterLink. If less than zero, the Set was null.
  - iterateExcitationFilterLink
```
public Iterator<FilterSetExcitationFilterLink> iterateExcitationFilterLink()
```
    should be used rather than accessing the excitationFilterLink set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfExcitationFilterLink() is less than zero.
  - unmodifiableExcitationFilterLink
```
public Collection<FilterSetExcitationFilterLink> unmodifiableExcitationFilterLink()
```
    Returns an unmodifiable collection-view
  - collectExcitationFilterLink
```
public <E> List<E> collectExcitationFilterLink(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.acquisition.FilterSetExcitationFilterLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateExcitationFilterLink() internally and so will return a value even if the underlying collection is null.
  - addFilterSetExcitationFilterLink
```
public void addFilterSetExcitationFilterLink(FilterSetExcitationFilterLink target)
```
    use instead of setExcitationFilterLink . Makes the necessary call on ome.model.acquisition.FilterSetExcitationFilterLink as well.
  - addFilterSetExcitationFilterLinkSet
```
public void addFilterSetExcitationFilterLinkSet(Collection<FilterSetExcitationFilterLink> targets)
```
    use like addFilterSetExcitationFilterLink.
  - removeFilterSetExcitationFilterLink
```
public void removeFilterSetExcitationFilterLink(FilterSetExcitationFilterLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.acquisition.FilterSetExcitationFilterLink
  - removeFilterSetExcitationFilterLinkSet
```
public void removeFilterSetExcitationFilterLinkSet(Collection<FilterSetExcitationFilterLink> targets)
```
    use like removeFilterSetExcitationFilterLink
  - linkExcitationFilter
```
public FilterSetExcitationFilterLink linkExcitationFilter(FilterSet addition)
```
    Adds a ome.model.acquisition.FilterSetExcitationFilterLink to excitationFilterLink . This entails changing our excitationFilterLink Set, creating a new ome.model.acquisition.FilterSetExcitationFilterLink and calling linkExcitationFilter on the ome.model.acquisition.FilterSet.
  - addFilterSetExcitationFilterLink
```
public void addFilterSetExcitationFilterLink(FilterSetExcitationFilterLink link,
                                             boolean bothSides)
```
    Adds a ome.model.acquisition.FilterSetExcitationFilterLink to excitationFilterLink, allowing for recursion -- whether or not addFilterSetExcitationFilterLink will be called on the addition if it is loaded
  - linkedExcitationFilterIterator
```
public Iterator<FilterSet> linkedExcitationFilterIterator()
```
    provides an iterator over the child values of the excitationFilterLink. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedExcitationFilterList() instead.
  - findFilterSetExcitationFilterLink
```
public Set<FilterSetExcitationFilterLink> findFilterSetExcitationFilterLink(FilterSet target)
```
    find all ome.model.acquisition.FilterSetExcitationFilterLink which have the argument as their parent.
  - linkedExcitationFilterList
```
public List<FilterSet> linkedExcitationFilterList()
```
    produces a List-copy of the underlying collection. Unlike, linkedExcitationFilterIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
  - eachLinkedExcitationFilter
```
public <E> List<E> eachLinkedExcitationFilter(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.acquisition.FilterSet while collecting the results. If block == null, then the iterator values themselves are collected.
  - unlinkExcitationFilter
```
public void unlinkExcitationFilter(FilterSet removal)
```
    unlinks all ome.model.acquisition.FilterSet instances from this instance.
  - removeFilterSetExcitationFilterLink
```
public void removeFilterSetExcitationFilterLink(FilterSetExcitationFilterLink link,
                                                boolean bothSides)
```
    removes the given FilterSetExcitationFilterLink from excitationFilterLink, allowing for recursion -- whether or not the removal will call unlinkFilter again if loaded.
  - clearExcitationFilterLinks
```
public void clearExcitationFilterLinks()
```
    clears the set.
  - setExcitationFilterLinkCountPerOwner
```
protected void setExcitationFilterLinkCountPerOwner(Map<Long,Long> map)
```
  - getExcitationFilterLinkCountPerOwner
```
public Map<Long,Long> getExcitationFilterLinkCountPerOwner()
```
    If fetched, returns the count(*) of ome.model.acquisition.FilterSetExcitationFilterLink that a user has. If unfetched, returns null. No entries in the collection should be null.
  - getEmissionFilterLink
```
protected Set<FilterSetEmissionFilterLink> getEmissionFilterLink()
```
    returns emissionFilterLink . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.acquisition.Filter.emissionFilterLink (ome.model.acquisition.FilterSetEmissionFilterLink)
  - setEmissionFilterLink
```
protected void setEmissionFilterLink(Set<FilterSetEmissionFilterLink> emissionFilterLink)
```
    setter for emissionFilterLink should be avoided. Does not fulfill normal semantics.
  - sizeOfEmissionFilterLink
```
public int sizeOfEmissionFilterLink()
```
    returns the size of emissionFilterLink. If less than zero, the Set was null.
  - iterateEmissionFilterLink
```
public Iterator<FilterSetEmissionFilterLink> iterateEmissionFilterLink()
```
    should be used rather than accessing the emissionFilterLink set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfEmissionFilterLink() is less than zero.
  - unmodifiableEmissionFilterLink
```
public Collection<FilterSetEmissionFilterLink> unmodifiableEmissionFilterLink()
```
    Returns an unmodifiable collection-view
  - collectEmissionFilterLink
```
public <E> List<E> collectEmissionFilterLink(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.acquisition.FilterSetEmissionFilterLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateEmissionFilterLink() internally and so will return a value even if the underlying collection is null.
  - addFilterSetEmissionFilterLink
```
public void addFilterSetEmissionFilterLink(FilterSetEmissionFilterLink target)
```
    use instead of setEmissionFilterLink . Makes the necessary call on ome.model.acquisition.FilterSetEmissionFilterLink as well.
  - addFilterSetEmissionFilterLinkSet
```
public void addFilterSetEmissionFilterLinkSet(Collection<FilterSetEmissionFilterLink> targets)
```
    use like addFilterSetEmissionFilterLink.
  - removeFilterSetEmissionFilterLink
```
public void removeFilterSetEmissionFilterLink(FilterSetEmissionFilterLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.acquisition.FilterSetEmissionFilterLink
  - removeFilterSetEmissionFilterLinkSet
```
public void removeFilterSetEmissionFilterLinkSet(Collection<FilterSetEmissionFilterLink> targets)
```
    use like removeFilterSetEmissionFilterLink
  - linkEmissionFilter
```
public FilterSetEmissionFilterLink linkEmissionFilter(FilterSet addition)
```
    Adds a ome.model.acquisition.FilterSetEmissionFilterLink to emissionFilterLink . This entails changing our emissionFilterLink Set, creating a new ome.model.acquisition.FilterSetEmissionFilterLink and calling linkEmissionFilter on the ome.model.acquisition.FilterSet.
  - addFilterSetEmissionFilterLink
```
public void addFilterSetEmissionFilterLink(FilterSetEmissionFilterLink link,
                                           boolean bothSides)
```
    Adds a ome.model.acquisition.FilterSetEmissionFilterLink to emissionFilterLink, allowing for recursion -- whether or not addFilterSetEmissionFilterLink will be called on the addition if it is loaded
  - linkedEmissionFilterIterator
```
public Iterator<FilterSet> linkedEmissionFilterIterator()
```
    provides an iterator over the child values of the emissionFilterLink. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedEmissionFilterList() instead.
  - findFilterSetEmissionFilterLink
```
public Set<FilterSetEmissionFilterLink> findFilterSetEmissionFilterLink(FilterSet target)
```
    find all ome.model.acquisition.FilterSetEmissionFilterLink which have the argument as their parent.
  - linkedEmissionFilterList
```
public List<FilterSet> linkedEmissionFilterList()
```
    produces a List-copy of the underlying collection. Unlike, linkedEmissionFilterIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
  - eachLinkedEmissionFilter
```
public <E> List<E> eachLinkedEmissionFilter(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.acquisition.FilterSet while collecting the results. If block == null, then the iterator values themselves are collected.
  - unlinkEmissionFilter
```
public void unlinkEmissionFilter(FilterSet removal)
```
    unlinks all ome.model.acquisition.FilterSet instances from this instance.
  - removeFilterSetEmissionFilterLink
```
public void removeFilterSetEmissionFilterLink(FilterSetEmissionFilterLink link,
                                              boolean bothSides)
```
    removes the given FilterSetEmissionFilterLink from emissionFilterLink, allowing for recursion -- whether or not the removal will call unlinkFilter again if loaded.
  - clearEmissionFilterLinks
```
public void clearEmissionFilterLinks()
```
    clears the set.
  - setEmissionFilterLinkCountPerOwner
```
protected void setEmissionFilterLinkCountPerOwner(Map<Long,Long> map)
```
  - getEmissionFilterLinkCountPerOwner
```
public Map<Long,Long> getEmissionFilterLinkCountPerOwner()
```
    If fetched, returns the count(*) of ome.model.acquisition.FilterSetEmissionFilterLink that a user has. If unfetched, returns null. No entries in the collection should be null.
  - getAnnotationLinks
```
protected Set<FilterAnnotationLink> getAnnotationLinks()
```
    returns annotationLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.acquisition.Filter.annotationLinks (ome.model.annotations.FilterAnnotationLink)
  - setAnnotationLinks
```
protected void setAnnotationLinks(Set<FilterAnnotationLink> annotationLinks)
```
    setter for annotationLinks should be avoided. Does not fulfill normal semantics.
  - sizeOfAnnotationLinks
```
public int sizeOfAnnotationLinks()
```
    returns the size of annotationLinks. If less than zero, the Set was null.
    
    Specified by:
    
    sizeOfAnnotationLinks in interface IAnnotated
  - iterateAnnotationLinks
```
public Iterator<FilterAnnotationLink> iterateAnnotationLinks()
```
    should be used rather than accessing the annotationLinks set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfAnnotationLinks() is less than zero.
    
    Specified by:
    
    iterateAnnotationLinks in interface IAnnotated
  - unmodifiableAnnotationLinks
```
public Collection<FilterAnnotationLink> unmodifiableAnnotationLinks()
```
    Returns an unmodifiable collection-view
    
    Specified by:
    
    unmodifiableAnnotationLinks in interface IAnnotated
  - collectAnnotationLinks
```
public <E> List<E> collectAnnotationLinks(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.annotations.FilterAnnotationLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateAnnotationLinks() internally and so will return a value even if the underlying collection is null.
    
    Specified by:
    
    collectAnnotationLinks in interface IAnnotated
  - addFilterAnnotationLink
```
public void addFilterAnnotationLink(FilterAnnotationLink target)
```
    use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.FilterAnnotationLink as well.
  - addFilterAnnotationLinkSet
```
public void addFilterAnnotationLinkSet(Collection<FilterAnnotationLink> targets)
```
    use like addFilterAnnotationLink.
  - removeFilterAnnotationLink
```
public void removeFilterAnnotationLink(FilterAnnotationLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.annotations.FilterAnnotationLink
  - removeFilterAnnotationLinkSet
```
public void removeFilterAnnotationLinkSet(Collection<FilterAnnotationLink> targets)
```
    use like removeFilterAnnotationLink
  - linkAnnotation
```
public FilterAnnotationLink linkAnnotation(Annotation addition)
```
    Adds a ome.model.annotations.FilterAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.FilterAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.
    
    Specified by:
    
    linkAnnotation in interface IAnnotated
  - addFilterAnnotationLink
```
public void addFilterAnnotationLink(FilterAnnotationLink link,
                                    boolean bothSides)
```
    Adds a ome.model.annotations.FilterAnnotationLink to annotationLinks, allowing for recursion -- whether or not addFilterAnnotationLink will be called on the addition if it is loaded
  - linkedAnnotationIterator
```
public Iterator<Annotation> linkedAnnotationIterator()
```
    provides an iterator over the parent values of the annotationLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedAnnotationList() instead.
    
    Specified by:
    
    linkedAnnotationIterator in interface IAnnotated
  - findFilterAnnotationLink
```
public Set<FilterAnnotationLink> findFilterAnnotationLink(Annotation target)
```
    find all ome.model.annotations.FilterAnnotationLink which have the argument as their child.
  - linkedAnnotationList
```
public List<Annotation> linkedAnnotationList()
```
    produces a List-copy of the underlying collection. Unlike, linkedAnnotationIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
    
    Specified by:
    
    linkedAnnotationList in interface IAnnotated
  - eachLinkedAnnotation
```
public <E> List<E> eachLinkedAnnotation(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results. If block == null, then the iterator values themselves are collected.
    
    Specified by:
    
    eachLinkedAnnotation in interface IAnnotated
  - unlinkAnnotation
```
public void unlinkAnnotation(Annotation removal)
```
    unlinks all ome.model.annotations.Annotation instances from this instance.
    
    Specified by:
    
    unlinkAnnotation in interface IAnnotated
  - removeFilterAnnotationLink
```
public void removeFilterAnnotationLink(FilterAnnotationLink link,
                                       boolean bothSides)
```
    removes the given FilterAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkFilter again if loaded.
  - clearAnnotationLinks
```
public void clearAnnotationLinks()
```
    clears the set.
    
    Specified by:
    
    clearAnnotationLinks in interface IAnnotated
  - setAnnotationLinksCountPerOwner
```
protected void setAnnotationLinksCountPerOwner(Map<Long,Long> map)
```
  - getAnnotationLinksCountPerOwner
```
public Map<Long,Long> getAnnotationLinksCountPerOwner()
```
    If fetched, returns the count(*) of ome.model.annotations.FilterAnnotationLink that a user has. If unfetched, returns null. No entries in the collection should be null.
  - getDetails
```
public Details getDetails()
```
    The details of this object correspond to low-level system information. Owner, permissions, Details is always guaranteed to be non-null, unless the user actively nulls it. Every entity also contains a Detail reference, which doesn't refer to a separate table but rather to a collection of fields collected into a Hibernate "component" which is embedded in the object. HQL queries which refer to the Details component cannot directly fetch the entity like this: select o from Object join fetch o.details but rather each field of the Details instance must be explicitly joined: select o from Object join fetch o.details.owner It should also be noted that not all types have all the fields which are present on Details. For example, select e from Experimenter e join fetch e.details.owner will fail. Experimenter has no owner, for obvious reasons. Note: subclasses of this class will return a subclass of the Details type.
    
    Specified by:
    
    getDetails in interface IObject
  - setDetails
```
protected void setDetails(Details details)
```
    Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the Filter.Details instance instead.
  - isValid
```
public boolean isValid()
```
    Description copied from interface: IObject
    
    calls the class-specific validator for this instance and returns the value from Validation.isValid()
    
    Specified by:
    
    isValid in interface IObject
  - validate
```
public Validation validate()
```
    Description copied from interface: IObject
    
    calls the class-specific validator for this instance and returns the Validation object.
    
    Specified by:
    
    validate in interface IObject
    
    Returns:
    
    Validation collecting parameter.
  - newInstance
```
public Filter newInstance()
```
  - proxy
```
public Filter proxy()
```
  - acceptFilter
```
public boolean acceptFilter(Filter __filter)
```
    Specified by:
    
    acceptFilter in interface Filterable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fields
```
public Set<String> fields()
```
    Description copied from interface: IObject
    
    returns a Set of field names that belong to this class
    
    Specified by:
    
    fields in interface IObject
  - retrieve
```
public Object retrieve(String field)
```
    Description copied from interface: IObject
    
    retrieves a value from this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be retrieved from a lazy-loaded map filled by calls to IObject.putAt(String, Object)
    
    Specified by:
    
    retrieve in interface IObject
  - putAt
```
public void putAt(String field,
                  Object value)
```
    Description copied from interface: IObject
    
    stores a value in this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be stored in a lazy-loaded map.
    
    Specified by:
    
    putAt in interface IObject
    
    Parameters:
    
    field - Field name
    
    value - Any object to be stored.
  - isLoaded
```
public boolean isLoaded()
```
    Description copied from interface: IObject
    
    transient field (not stored in the DB) which specifies whether this object has been loaded from the DB or is only a wrapper around the ID.
    
    Specified by:
    
    isLoaded in interface IObject
  - errorIfUnloaded
```
protected void errorIfUnloaded()
```
  - unload
```
public void unload()
```
    Description copied from interface: IObject
    
    set the loaded field to false, and set all non-ID fields to null. Subsequent calls to all accessors other than getId/setId will throw an ApiUsageException
    
    Specified by:
    
    unload in interface IObject
  - getGraphHolder
```
public final GraphHolder getGraphHolder()
```
    Description copied from interface: IObject
    
    retrieves the GraphHolder for this entity. If the GraphHolder has not been actively set, a new one will be instatiated.
    
    Specified by:
    
    getGraphHolder in interface IObject
    
    Returns:
    
    Non-null GraphHolder
  - throwNullCollectionException
```
protected void throwNullCollectionException(String propertyName)
```

Class Filter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OWNER_FILTER

GROUP_FILTER

EVENT_FILTER

PERMS_FILTER

ID

id

VERSION

version

manufacturer

model

lotNumber

serialNumber

filterWheel

type

transmittanceRange

instrument

excitationFilterLink

OWNER_FILTER_EXCITATIONFILTERLINK

GROUP_FILTER_EXCITATIONFILTERLINK

EVENT_FILTER_EXCITATIONFILTERLINK

PERMS_FILTER_EXCITATIONFILTERLINK

emissionFilterLink

OWNER_FILTER_EMISSIONFILTERLINK

GROUP_FILTER_EMISSIONFILTERLINK

EVENT_FILTER_EMISSIONFILTERLINK

PERMS_FILTER_EMISSIONFILTERLINK

annotationLinks

OWNER_FILTER_ANNOTATIONLINKS

GROUP_FILTER_ANNOTATIONLINKS

EVENT_FILTER_ANNOTATIONLINKS

PERMS_FILTER_ANNOTATIONLINKS

details

MANUFACTURER

MODEL

LOTNUMBER

SERIALNUMBER

FILTERWHEEL

TYPE

TRANSMITTANCERANGE

INSTRUMENT

EXCITATIONFILTERLINKCOUNTPEROWNER

EXCITATIONFILTERLINK

EMISSIONFILTERLINKCOUNTPEROWNER

EMISSIONFILTERLINK

ANNOTATIONLINKSCOUNTPEROWNER

ANNOTATIONLINKS

DETAILS

FIELDS

_dynamicFields

_loaded

Constructor Detail

Filter

Filter

Filter

Filter

Method Detail

getId

setId

getVersion

setVersion

getManufacturer

setManufacturer

getModel

setModel

getLotNumber

setLotNumber

getSerialNumber

setSerialNumber

getFilterWheel

setFilterWheel

getType

setType

getTransmittanceRange