Package ome.model.acquisition
Class FilterSet
- java.lang.Object
-
- ome.model.acquisition.FilterSet
-
- All Implemented Interfaces:
java.io.Serializable
,IMutable
,IObject
,Filterable
@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class FilterSet extends java.lang.Object implements java.io.Serializable, IObject, IMutable
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 Description static class
FilterSet.Details
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<java.lang.String,java.lang.Object>
_dynamicFields
protected boolean
_loaded
protected Details
details
static java.lang.String
DETAILS
protected Dichroic
dichroic
static java.lang.String
DICHROIC
protected java.util.Set<FilterSetEmissionFilterLink>
emissionFilterLink
static java.lang.String
EMISSIONFILTERLINK
static java.lang.String
EMISSIONFILTERLINKCOUNTPEROWNER
static java.lang.String
EVENT_FILTER
static java.lang.String
EVENT_FILTER_EMISSIONFILTERLINK
static java.lang.String
EVENT_FILTER_EXCITATIONFILTERLINK
protected java.util.Set<FilterSetExcitationFilterLink>
excitationFilterLink
static java.lang.String
EXCITATIONFILTERLINK
static java.lang.String
EXCITATIONFILTERLINKCOUNTPEROWNER
static java.util.Set<java.lang.String>
FIELDS
static java.lang.String
GROUP_FILTER
static java.lang.String
GROUP_FILTER_EMISSIONFILTERLINK
static java.lang.String
GROUP_FILTER_EXCITATIONFILTERLINK
protected java.lang.Long
id
static java.lang.String
ID
protected Instrument
instrument
static java.lang.String
INSTRUMENT
protected java.lang.String
lotNumber
static java.lang.String
LOTNUMBER
protected java.lang.String
manufacturer
static java.lang.String
MANUFACTURER
protected java.lang.String
model
static java.lang.String
MODEL
static java.lang.String
OWNER_FILTER
static java.lang.String
OWNER_FILTER_EMISSIONFILTERLINK
static java.lang.String
OWNER_FILTER_EXCITATIONFILTERLINK
static java.lang.String
PERMS_FILTER
static java.lang.String
PERMS_FILTER_EMISSIONFILTERLINK
static java.lang.String
PERMS_FILTER_EXCITATIONFILTERLINK
protected java.lang.String
serialNumber
static java.lang.String
SERIALNUMBER
protected java.lang.Integer
version
static java.lang.String
VERSION
-
Constructor Summary
Constructors Modifier Constructor Description FilterSet()
protected
FilterSet(java.lang.Long id)
FilterSet(java.lang.Long id, boolean loaded)
Main constructor.FilterSet(Instrument _instrument)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
acceptFilter(Filter __filter)
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 loadedvoid
addFilterSetEmissionFilterLinkSet(java.util.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 loadedvoid
addFilterSetExcitationFilterLinkSet(java.util.Collection<FilterSetExcitationFilterLink> targets)
use like addFilterSetExcitationFilterLink.void
clearEmissionFilterLinks()
clears the set.void
clearExcitationFilterLinks()
clears the set.<E> java.util.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> java.util.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> java.util.List<E>
eachLinkedEmissionFilter(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.acquisition.Filter while collecting the results.<E> java.util.List<E>
eachLinkedExcitationFilter(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.acquisition.Filter while collecting the results.protected void
errorIfUnloaded()
java.util.Set<java.lang.String>
fields()
returns a Set of field names that belong to this classjava.util.Set<FilterSetEmissionFilterLink>
findFilterSetEmissionFilterLink(Filter target)
find all ome.model.acquisition.FilterSetEmissionFilterLink which have the argument as their child.java.util.Set<FilterSetExcitationFilterLink>
findFilterSetExcitationFilterLink(Filter target)
find all ome.model.acquisition.FilterSetExcitationFilterLink which have the argument as their child.Details
getDetails()
The details of this object correspond to low-level system information.Dichroic
getDichroic()
Many-to-one field ome.model.acquisition.FilterSet.dichroic (ome.model.acquisition.Dichroic)protected java.util.Set<FilterSetEmissionFilterLink>
getEmissionFilterLink()
returns emissionFilterLink .java.util.Map<java.lang.Long,java.lang.Long>
getEmissionFilterLinkCountPerOwner()
If fetched, returns the count(*) of ome.model.acquisition.FilterSetEmissionFilterLink that a user has.protected java.util.Set<FilterSetExcitationFilterLink>
getExcitationFilterLink()
returns excitationFilterLink .java.util.Map<java.lang.Long,java.lang.Long>
getExcitationFilterLinkCountPerOwner()
If fetched, returns the count(*) of ome.model.acquisition.FilterSetExcitationFilterLink that a user has.GraphHolder
getGraphHolder()
retrieves theGraphHolder
for this entity.java.lang.Long
getId()
The DB unique identifier for this object.Instrument
getInstrument()
Many-to-one field ome.model.acquisition.FilterSet.instrument (ome.model.acquisition.Instrument)java.lang.String
getLotNumber()
Simple field ome.model.acquisition.FilterSet.lotNumber (java.lang.String)java.lang.String
getManufacturer()
Simple field ome.model.acquisition.FilterSet.manufacturer (java.lang.String)java.lang.String
getModel()
Simple field ome.model.acquisition.FilterSet.model (java.lang.String)java.lang.String
getSerialNumber()
Simple field ome.model.acquisition.FilterSet.serialNumber (java.lang.String)java.lang.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 fromValidation.isValid()
java.util.Iterator<FilterSetEmissionFilterLink>
iterateEmissionFilterLink()
should be used rather than accessing the emissionFilterLink set directly.java.util.Iterator<FilterSetExcitationFilterLink>
iterateExcitationFilterLink()
should be used rather than accessing the excitationFilterLink set directly.java.util.Iterator<Filter>
linkedEmissionFilterIterator()
provides an iterator over the parent values of the emissionFilterLink.java.util.List<Filter>
linkedEmissionFilterList()
produces aList
-copy of the underlying collection.java.util.Iterator<Filter>
linkedExcitationFilterIterator()
provides an iterator over the parent values of the excitationFilterLink.java.util.List<Filter>
linkedExcitationFilterList()
produces aList
-copy of the underlying collection.FilterSetEmissionFilterLink
linkEmissionFilter(Filter addition)
Adds a ome.model.acquisition.FilterSetEmissionFilterLink to emissionFilterLink .FilterSetExcitationFilterLink
linkExcitationFilter(Filter addition)
Adds a ome.model.acquisition.FilterSetExcitationFilterLink to excitationFilterLink .FilterSet
newInstance()
FilterSet
proxy()
void
putAt(java.lang.String field, java.lang.Object value)
stores a value in this instance.void
removeFilterSetEmissionFilterLink(FilterSetEmissionFilterLink target)
removes a single element from this set and makes the inverse call on ome.model.acquisition.FilterSetEmissionFilterLinkvoid
removeFilterSetEmissionFilterLink(FilterSetEmissionFilterLink link, boolean bothSides)
removes the given FilterSetEmissionFilterLink from emissionFilterLink, allowing for recursion -- whether or not the removal will call unlinkFilterSet again if loaded.void
removeFilterSetEmissionFilterLinkSet(java.util.Collection<FilterSetEmissionFilterLink> targets)
use like removeFilterSetEmissionFilterLinkvoid
removeFilterSetExcitationFilterLink(FilterSetExcitationFilterLink target)
removes a single element from this set and makes the inverse call on ome.model.acquisition.FilterSetExcitationFilterLinkvoid
removeFilterSetExcitationFilterLink(FilterSetExcitationFilterLink link, boolean bothSides)
removes the given FilterSetExcitationFilterLink from excitationFilterLink, allowing for recursion -- whether or not the removal will call unlinkFilterSet again if loaded.void
removeFilterSetExcitationFilterLinkSet(java.util.Collection<FilterSetExcitationFilterLink> targets)
use like removeFilterSetExcitationFilterLinkjava.lang.Object
retrieve(java.lang.String field)
retrieves a value from this instance.protected void
setDetails(Details details)
void
setDichroic(Dichroic dichroic)
protected void
setEmissionFilterLink(java.util.Set<FilterSetEmissionFilterLink> emissionFilterLink)
setter for emissionFilterLink should be avoided.protected void
setEmissionFilterLinkCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
protected void
setExcitationFilterLink(java.util.Set<FilterSetExcitationFilterLink> excitationFilterLink)
setter for excitationFilterLink should be avoided.protected void
setExcitationFilterLinkCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
void
setId(java.lang.Long id)
usually unneeded.void
setInstrument(Instrument instrument)
void
setLotNumber(java.lang.String lotNumber)
void
setManufacturer(java.lang.String manufacturer)
void
setModel(java.lang.String model)
void
setSerialNumber(java.lang.String serialNumber)
void
setVersion(java.lang.Integer version)
use with caution.int
sizeOfEmissionFilterLink()
returns the size of emissionFilterLink.int
sizeOfExcitationFilterLink()
returns the size of excitationFilterLink.protected void
throwNullCollectionException(java.lang.String propertyName)
java.lang.String
toString()
void
unlinkEmissionFilter(Filter removal)
unlinks all ome.model.acquisition.Filter instances from this instance.void
unlinkExcitationFilter(Filter removal)
unlinks all ome.model.acquisition.Filter instances from this instance.void
unload()
set the loaded field to false, and set all non-ID fields to null.java.util.Collection<FilterSetEmissionFilterLink>
unmodifiableEmissionFilterLink()
Returns an unmodifiable collection-viewjava.util.Collection<FilterSetExcitationFilterLink>
unmodifiableExcitationFilterLink()
Returns an unmodifiable collection-viewValidation
validate()
calls the class-specific validator for this instance and returns theValidation
object.
-
-
-
Field Detail
-
OWNER_FILTER
public static final java.lang.String OWNER_FILTER
- See Also:
- Constant Field Values
-
GROUP_FILTER
public static final java.lang.String GROUP_FILTER
- See Also:
- Constant Field Values
-
EVENT_FILTER
public static final java.lang.String EVENT_FILTER
- See Also:
- Constant Field Values
-
PERMS_FILTER
public static final java.lang.String PERMS_FILTER
- See Also:
- Constant Field Values
-
ID
public static final java.lang.String ID
- See Also:
- Constant Field Values
-
id
protected java.lang.Long id
-
VERSION
public static final java.lang.String VERSION
- See Also:
- Constant Field Values
-
version
protected java.lang.Integer version
-
manufacturer
protected java.lang.String manufacturer
-
model
protected java.lang.String model
-
lotNumber
protected java.lang.String lotNumber
-
serialNumber
protected java.lang.String serialNumber
-
instrument
protected Instrument instrument
-
excitationFilterLink
protected java.util.Set<FilterSetExcitationFilterLink> excitationFilterLink
-
OWNER_FILTER_EXCITATIONFILTERLINK
public static final java.lang.String OWNER_FILTER_EXCITATIONFILTERLINK
- See Also:
- Constant Field Values
-
GROUP_FILTER_EXCITATIONFILTERLINK
public static final java.lang.String GROUP_FILTER_EXCITATIONFILTERLINK
- See Also:
- Constant Field Values
-
EVENT_FILTER_EXCITATIONFILTERLINK
public static final java.lang.String EVENT_FILTER_EXCITATIONFILTERLINK
- See Also:
- Constant Field Values
-
PERMS_FILTER_EXCITATIONFILTERLINK
public static final java.lang.String PERMS_FILTER_EXCITATIONFILTERLINK
- See Also:
- Constant Field Values
-
dichroic
protected Dichroic dichroic
-
emissionFilterLink
protected java.util.Set<FilterSetEmissionFilterLink> emissionFilterLink
-
OWNER_FILTER_EMISSIONFILTERLINK
public static final java.lang.String OWNER_FILTER_EMISSIONFILTERLINK
- See Also:
- Constant Field Values
-
GROUP_FILTER_EMISSIONFILTERLINK
public static final java.lang.String GROUP_FILTER_EMISSIONFILTERLINK
- See Also:
- Constant Field Values
-
EVENT_FILTER_EMISSIONFILTERLINK
public static final java.lang.String EVENT_FILTER_EMISSIONFILTERLINK
- See Also:
- Constant Field Values
-
PERMS_FILTER_EMISSIONFILTERLINK
public static final java.lang.String PERMS_FILTER_EMISSIONFILTERLINK
- See Also:
- Constant Field Values
-
details
protected Details details
-
MANUFACTURER
public static final java.lang.String MANUFACTURER
- See Also:
- Constant Field Values
-
MODEL
public static final java.lang.String MODEL
- See Also:
- Constant Field Values
-
LOTNUMBER
public static final java.lang.String LOTNUMBER
- See Also:
- Constant Field Values
-
SERIALNUMBER
public static final java.lang.String SERIALNUMBER
- See Also:
- Constant Field Values
-
INSTRUMENT
public static final java.lang.String INSTRUMENT
- See Also:
- Constant Field Values
-
EXCITATIONFILTERLINKCOUNTPEROWNER
public static final java.lang.String EXCITATIONFILTERLINKCOUNTPEROWNER
- See Also:
- Constant Field Values
-
EXCITATIONFILTERLINK
public static final java.lang.String EXCITATIONFILTERLINK
- See Also:
- Constant Field Values
-
DICHROIC
public static final java.lang.String DICHROIC
- See Also:
- Constant Field Values
-
EMISSIONFILTERLINKCOUNTPEROWNER
public static final java.lang.String EMISSIONFILTERLINKCOUNTPEROWNER
- See Also:
- Constant Field Values
-
EMISSIONFILTERLINK
public static final java.lang.String EMISSIONFILTERLINK
- See Also:
- Constant Field Values
-
DETAILS
public static final java.lang.String DETAILS
- See Also:
- Constant Field Values
-
FIELDS
public static final java.util.Set<java.lang.String> FIELDS
-
_dynamicFields
protected java.util.Map<java.lang.String,java.lang.Object> _dynamicFields
-
_loaded
protected boolean _loaded
-
-
Constructor Detail
-
FilterSet
public FilterSet()
-
FilterSet
protected FilterSet(java.lang.Long id)
-
FilterSet
public FilterSet(java.lang.Long id, boolean loaded)
Main constructor.
-
FilterSet
public FilterSet(Instrument _instrument)
-
-
Method Detail
-
getId
@DocumentId public java.lang.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.
-
setId
public void setId(java.lang.Long id)
Description copied from interface:IObject
usually unneeded. Ids are managed by the backend.
-
getVersion
public java.lang.Integer getVersion()
This version number is controlled by the database for optimisitic locking.- Specified by:
getVersion
in interfaceIMutable
-
setVersion
public void setVersion(java.lang.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 interfaceIMutable
- Parameters:
version
- Value for this objects version.
-
getManufacturer
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields") public java.lang.String getManufacturer()
Simple field ome.model.acquisition.FilterSet.manufacturer (java.lang.String)
-
setManufacturer
public void setManufacturer(java.lang.String manufacturer)
-
getModel
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields") public java.lang.String getModel()
Simple field ome.model.acquisition.FilterSet.model (java.lang.String)
-
setModel
public void setModel(java.lang.String model)
-
getLotNumber
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields") public java.lang.String getLotNumber()
Simple field ome.model.acquisition.FilterSet.lotNumber (java.lang.String)
-
setLotNumber
public void setLotNumber(java.lang.String lotNumber)
-
getSerialNumber
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields") public java.lang.String getSerialNumber()
Simple field ome.model.acquisition.FilterSet.serialNumber (java.lang.String)
-
setSerialNumber
public void setSerialNumber(java.lang.String serialNumber)
-
getInstrument
public Instrument getInstrument()
Many-to-one field ome.model.acquisition.FilterSet.instrument (ome.model.acquisition.Instrument)
-
setInstrument
public void setInstrument(Instrument instrument)
-
getExcitationFilterLink
protected java.util.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.FilterSet.excitationFilterLink (ome.model.acquisition.FilterSetExcitationFilterLink)
-
setExcitationFilterLink
protected void setExcitationFilterLink(java.util.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 java.util.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 ofEmptyIterator
. To test for a null collection, see ofsizeOfExcitationFilterLink()
is less than zero.
-
unmodifiableExcitationFilterLink
public java.util.Collection<FilterSetExcitationFilterLink> unmodifiableExcitationFilterLink()
Returns an unmodifiable collection-view
-
collectExcitationFilterLink
public <E> java.util.List<E> collectExcitationFilterLink(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.acquisition.FilterSetExcitationFilterLink while collecting the results. Ifblock == null
, then the iterator values themselves are collected. This method usesiterateExcitationFilterLink()
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(java.util.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(java.util.Collection<FilterSetExcitationFilterLink> targets)
use like removeFilterSetExcitationFilterLink
-
linkExcitationFilter
public FilterSetExcitationFilterLink linkExcitationFilter(Filter 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.Filter.
-
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 java.util.Iterator<Filter> linkedExcitationFilterIterator()
provides an iterator over the parent values of the excitationFilterLink. Like with most Collection iterators, modifications to the underlying collection while iterating will result in anConcurrentModificationException
. UselinkedExcitationFilterList()
instead.
-
findFilterSetExcitationFilterLink
public java.util.Set<FilterSetExcitationFilterLink> findFilterSetExcitationFilterLink(Filter target)
find all ome.model.acquisition.FilterSetExcitationFilterLink which have the argument as their child.
-
linkedExcitationFilterList
public java.util.List<Filter> linkedExcitationFilterList()
produces aList
-copy of the underlying collection. Unlike,linkedExcitationFilterIterator()
, while using the returnedList
, modifications can be made to the underlying collection without throwingConcurrentModificationException
.
-
eachLinkedExcitationFilter
public <E> java.util.List<E> eachLinkedExcitationFilter(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.acquisition.Filter while collecting the results. Ifblock == null
, then the iterator values themselves are collected.
-
unlinkExcitationFilter
public void unlinkExcitationFilter(Filter removal)
unlinks all ome.model.acquisition.Filter 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 unlinkFilterSet again if loaded.
-
clearExcitationFilterLinks
public void clearExcitationFilterLinks()
clears the set.
-
setExcitationFilterLinkCountPerOwner
protected void setExcitationFilterLinkCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
-
getExcitationFilterLinkCountPerOwner
public java.util.Map<java.lang.Long,java.lang.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.
-
getDichroic
public Dichroic getDichroic()
Many-to-one field ome.model.acquisition.FilterSet.dichroic (ome.model.acquisition.Dichroic)
-
setDichroic
public void setDichroic(Dichroic dichroic)
-
getEmissionFilterLink
protected java.util.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.FilterSet.emissionFilterLink (ome.model.acquisition.FilterSetEmissionFilterLink)
-
setEmissionFilterLink
protected void setEmissionFilterLink(java.util.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 java.util.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 ofEmptyIterator
. To test for a null collection, see ofsizeOfEmissionFilterLink()
is less than zero.
-
unmodifiableEmissionFilterLink
public java.util.Collection<FilterSetEmissionFilterLink> unmodifiableEmissionFilterLink()
Returns an unmodifiable collection-view
-
collectEmissionFilterLink
public <E> java.util.List<E> collectEmissionFilterLink(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.acquisition.FilterSetEmissionFilterLink while collecting the results. Ifblock == null
, then the iterator values themselves are collected. This method usesiterateEmissionFilterLink()
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(java.util.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(java.util.Collection<FilterSetEmissionFilterLink> targets)
use like removeFilterSetEmissionFilterLink
-
linkEmissionFilter
public FilterSetEmissionFilterLink linkEmissionFilter(Filter 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.Filter.
-
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 java.util.Iterator<Filter> linkedEmissionFilterIterator()
provides an iterator over the parent values of the emissionFilterLink. Like with most Collection iterators, modifications to the underlying collection while iterating will result in anConcurrentModificationException
. UselinkedEmissionFilterList()
instead.
-
findFilterSetEmissionFilterLink
public java.util.Set<FilterSetEmissionFilterLink> findFilterSetEmissionFilterLink(Filter target)
find all ome.model.acquisition.FilterSetEmissionFilterLink which have the argument as their child.
-
linkedEmissionFilterList
public java.util.List<Filter> linkedEmissionFilterList()
produces aList
-copy of the underlying collection. Unlike,linkedEmissionFilterIterator()
, while using the returnedList
, modifications can be made to the underlying collection without throwingConcurrentModificationException
.
-
eachLinkedEmissionFilter
public <E> java.util.List<E> eachLinkedEmissionFilter(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.acquisition.Filter while collecting the results. Ifblock == null
, then the iterator values themselves are collected.
-
unlinkEmissionFilter
public void unlinkEmissionFilter(Filter removal)
unlinks all ome.model.acquisition.Filter 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 unlinkFilterSet again if loaded.
-
clearEmissionFilterLinks
public void clearEmissionFilterLinks()
clears the set.
-
setEmissionFilterLinkCountPerOwner
protected void setEmissionFilterLinkCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
-
getEmissionFilterLinkCountPerOwner
public java.util.Map<java.lang.Long,java.lang.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.
-
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 theDetails
type.- Specified by:
getDetails
in interfaceIObject
-
setDetails
protected void setDetails(Details details)
-
isValid
public boolean isValid()
Description copied from interface:IObject
calls the class-specific validator for this instance and returns the value fromValidation.isValid()
-
validate
public Validation validate()
Description copied from interface:IObject
calls the class-specific validator for this instance and returns theValidation
object.
-
newInstance
public FilterSet newInstance()
-
proxy
public FilterSet proxy()
-
acceptFilter
public boolean acceptFilter(Filter __filter)
- Specified by:
acceptFilter
in interfaceFilterable
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
fields
public java.util.Set<java.lang.String> fields()
Description copied from interface:IObject
returns a Set of field names that belong to this class
-
retrieve
public java.lang.Object retrieve(java.lang.String field)
Description copied from interface:IObject
retrieves a value from this instance. Values forfield
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 toIObject.putAt(String, Object)
-
putAt
public void putAt(java.lang.String field, java.lang.Object value)
Description copied from interface:IObject
stores a value in this instance. Values forfield
which match a field of this instance will be delegated to the accessors. Otherwise, values will be stored in a lazy-loaded map.
-
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.
-
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
-
getGraphHolder
public final GraphHolder getGraphHolder()
Description copied from interface:IObject
retrieves theGraphHolder
for this entity. If the GraphHolder has not been actively set, a new one will be instatiated.- Specified by:
getGraphHolder
in interfaceIObject
- Returns:
- Non-null GraphHolder
-
throwNullCollectionException
protected void throwNullCollectionException(java.lang.String propertyName)
-
-