LightPath (OMERO API)

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

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 LightPath
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 LightPath.Details

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`_dynamicFields`
`protected boolean`	`_loaded`
`protected Set<LightPathAnnotationLink>`	`annotationLinks`
`static String`	`ANNOTATIONLINKS`
`static String`	`ANNOTATIONLINKSCOUNTPEROWNER`
`protected Details`	`details`
`static String`	`DETAILS`
`protected Dichroic`	`dichroic`
`static String`	`DICHROIC`
`protected Set<LightPathEmissionFilterLink>`	`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 List<LightPathExcitationFilterLink>`	`excitationFilterLink`
`static String`	`EXCITATIONFILTERLINK`
`static String`	`EXCITATIONFILTERLINKCOUNTPEROWNER`
`static Set<String>`	`FIELDS`
`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`
`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 Integer`	`version`
`static String`	`VERSION`

Constructor Summary

Constructors
Modifier Constructor and Description

LightPath()

protected LightPath(Long id)

LightPath(Long id, boolean loaded)
Main constructor.

Constructors
Modifier	Constructor and Description
	`LightPath()`
`protected`	`LightPath(Long id)`
	`LightPath(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`	`addLightPathAnnotationLink(LightPathAnnotationLink target)` use instead of setAnnotationLinks .
`void`	`addLightPathAnnotationLink(LightPathAnnotationLink link, boolean bothSides)` Adds a ome.model.annotations.LightPathAnnotationLink to annotationLinks, allowing for recursion -- whether or not addLightPathAnnotationLink will be called on the addition if it is loaded
`void`	`addLightPathAnnotationLinkSet(Collection<LightPathAnnotationLink> targets)` use like addLightPathAnnotationLink.
`void`	`addLightPathEmissionFilterLink(LightPathEmissionFilterLink target)` use instead of setEmissionFilterLink .
`void`	`addLightPathEmissionFilterLink(LightPathEmissionFilterLink link, boolean bothSides)` Adds a ome.model.acquisition.LightPathEmissionFilterLink to emissionFilterLink, allowing for recursion -- whether or not addLightPathEmissionFilterLink will be called on the addition if it is loaded
`void`	`addLightPathEmissionFilterLinkSet(Collection<LightPathEmissionFilterLink> targets)` use like addLightPathEmissionFilterLink.
`void`	`addLightPathExcitationFilterLink(LightPathExcitationFilterLink target)` use instead of setExcitationFilterLink .
`void`	`addLightPathExcitationFilterLink(LightPathExcitationFilterLink link, boolean bothSides)` Adds a ome.model.acquisition.LightPathExcitationFilterLink to excitationFilterLink, allowing for recursion -- whether or not addLightPathExcitationFilterLink will be called on the addition if it is loaded
`void`	`addLightPathExcitationFilterLinkSet(Collection<LightPathExcitationFilterLink> targets)` use like addLightPathExcitationFilterLink.
`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.LightPathAnnotationLink while collecting the results.
`<E> List<E>`	`collectEmissionFilterLink(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.acquisition.LightPathEmissionFilterLink while collecting the results.
`<E> List<E>`	`collectExcitationFilterLink(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.acquisition.LightPathExcitationFilterLink 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.Filter while collecting the results.
`<E> 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()`
`Set<String>`	`fields()` returns a Set of field names that belong to this class
`Set<LightPathAnnotationLink>`	`findLightPathAnnotationLink(Annotation target)` find all ome.model.annotations.LightPathAnnotationLink which have the argument as their child.
`Set<LightPathEmissionFilterLink>`	`findLightPathEmissionFilterLink(Filter target)` find all ome.model.acquisition.LightPathEmissionFilterLink which have the argument as their child.
`Set<LightPathExcitationFilterLink>`	`findLightPathExcitationFilterLink(Filter target)` find all ome.model.acquisition.LightPathExcitationFilterLink which have the argument as their child.
`protected Set<LightPathAnnotationLink>`	`getAnnotationLinks()` returns annotationLinks .
`Map<Long,Long>`	`getAnnotationLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.annotations.LightPathAnnotationLink that a user has.
`Details`	`getDetails()` The details of this object correspond to low-level system information.
`Dichroic`	`getDichroic()` Many-to-one field ome.model.acquisition.LightPath.dichroic (ome.model.acquisition.Dichroic)
`protected Set<LightPathEmissionFilterLink>`	`getEmissionFilterLink()` returns emissionFilterLink .
`Map<Long,Long>`	`getEmissionFilterLinkCountPerOwner()` If fetched, returns the count(*) of ome.model.acquisition.LightPathEmissionFilterLink that a user has.
`protected List<LightPathExcitationFilterLink>`	`getExcitationFilterLink()` returns excitationFilterLink .
`Map<Long,Long>`	`getExcitationFilterLinkCountPerOwner()` If fetched, returns the count(*) of ome.model.acquisition.LightPathExcitationFilterLink that a user has.
`GraphHolder`	`getGraphHolder()` retrieves the `GraphHolder` for this entity.
`Long`	`getId()` The DB unique identifier for this object.
`LightPathExcitationFilterLink`	`getLightPathExcitationFilterLink(int index)` Gets the ome.model.acquisition.LightPathExcitationFilterLink at the given index.
`LightPathExcitationFilterLink`	`getPrimaryLightPathExcitationFilterLink()` Gets the first element of excitationFilterLink which can be interpreted as the primary or default element in some situations.
`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<LightPathAnnotationLink>`	`iterateAnnotationLinks()` should be used rather than accessing the annotationLinks set directly.
`Iterator<LightPathEmissionFilterLink>`	`iterateEmissionFilterLink()` should be used rather than accessing the emissionFilterLink set directly.
`Iterator<LightPathExcitationFilterLink>`	`iterateExcitationFilterLink()` should be used rather than accessing the excitationFilterLink set directly.
`LightPathAnnotationLink`	`linkAnnotation(Annotation addition)` Adds a ome.model.annotations.LightPathAnnotationLink 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<Filter>`	`linkedEmissionFilterIterator()` provides an iterator over the parent values of the emissionFilterLink.
`List<Filter>`	`linkedEmissionFilterList()` produces a `List`-copy of the underlying collection.
`Iterator<Filter>`	`linkedExcitationFilterIterator()` provides an iterator over the parent values of the excitationFilterLink.
`List<Filter>`	`linkedExcitationFilterList()` produces a `List`-copy of the underlying collection.
`LightPathEmissionFilterLink`	`linkEmissionFilter(Filter addition)` Adds a ome.model.acquisition.LightPathEmissionFilterLink to emissionFilterLink .
`LightPathExcitationFilterLink`	`linkExcitationFilter(Filter addition)` Adds a ome.model.acquisition.LightPathExcitationFilterLink to excitationFilterLink .
`LightPath`	`newInstance()`
`LightPath`	`proxy()`
`void`	`putAt(String field, Object value)` stores a value in this instance.
`void`	`removeLightPathAnnotationLink(LightPathAnnotationLink target)` removes a single element from this set and makes the inverse call on ome.model.annotations.LightPathAnnotationLink
`void`	`removeLightPathAnnotationLink(LightPathAnnotationLink link, boolean bothSides)` removes the given LightPathAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkLightPath again if loaded.
`void`	`removeLightPathAnnotationLinkSet(Collection<LightPathAnnotationLink> targets)` use like removeLightPathAnnotationLink
`void`	`removeLightPathEmissionFilterLink(LightPathEmissionFilterLink target)` removes a single element from this set and makes the inverse call on ome.model.acquisition.LightPathEmissionFilterLink
`void`	`removeLightPathEmissionFilterLink(LightPathEmissionFilterLink link, boolean bothSides)` removes the given LightPathEmissionFilterLink from emissionFilterLink, allowing for recursion -- whether or not the removal will call unlinkLightPath again if loaded.
`void`	`removeLightPathEmissionFilterLinkSet(Collection<LightPathEmissionFilterLink> targets)` use like removeLightPathEmissionFilterLink
`void`	`removeLightPathExcitationFilterLink(LightPathExcitationFilterLink target)` removes a single element from this set and makes the inverse call on ome.model.acquisition.LightPathExcitationFilterLink
`void`	`removeLightPathExcitationFilterLink(LightPathExcitationFilterLink link, boolean bothSides)` removes the given LightPathExcitationFilterLink from excitationFilterLink, allowing for recursion -- whether or not the removal will call unlinkLightPath again if loaded.
`void`	`removeLightPathExcitationFilterLinkSet(Collection<LightPathExcitationFilterLink> targets)` use like removeLightPathExcitationFilterLink
`Object`	`retrieve(String field)` retrieves a value from this instance.
`protected void`	`setAnnotationLinks(Set<LightPathAnnotationLink> 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 `LightPath.Details` instance instead.
`void`	`setDichroic(Dichroic dichroic)`
`protected void`	`setEmissionFilterLink(Set<LightPathEmissionFilterLink> emissionFilterLink)` setter for emissionFilterLink should be avoided.
`protected void`	`setEmissionFilterLinkCountPerOwner(Map<Long,Long> map)`
`protected void`	`setExcitationFilterLink(List<LightPathExcitationFilterLink> excitationFilterLink)` setter for excitationFilterLink should be avoided.
`protected void`	`setExcitationFilterLinkCountPerOwner(Map<Long,Long> map)`
`void`	`setId(Long id)` usually unneeded.
`LightPathExcitationFilterLink`	`setLightPathExcitationFilterLink(int index, LightPathExcitationFilterLink element)` Sets the ome.model.acquisition.LightPathExcitationFilterLink at the given index.
`LightPathExcitationFilterLink`	`setPrimaryLightPathExcitationFilterLink(LightPathExcitationFilterLink element)` Swaps the first element of excitationFilterLink with the first instance of the given element.
`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(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.
`Collection<LightPathAnnotationLink>`	`unmodifiableAnnotationLinks()` Returns an unmodifiable collection-view
`Collection<LightPathEmissionFilterLink>`	`unmodifiableEmissionFilterLink()` Returns an unmodifiable collection-view
`Collection<LightPathExcitationFilterLink>`	`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
```
  - excitationFilterLink
```
protected List<LightPathExcitationFilterLink> 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
  - dichroic
```
protected Dichroic dichroic
```
  - emissionFilterLink
```
protected Set<LightPathEmissionFilterLink> 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<LightPathAnnotationLink> 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
```
  - EXCITATIONFILTERLINKCOUNTPEROWNER
```
public static final String EXCITATIONFILTERLINKCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - EXCITATIONFILTERLINK
```
public static final String EXCITATIONFILTERLINK
```
    See Also:
    
    Constant Field Values
  - DICHROIC
```
public static final String DICHROIC
```
    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
  - LightPath
```
public LightPath()
```
  - LightPath
```
protected LightPath(Long id)
```
  - LightPath
```
public LightPath(Long id,
                 boolean loaded)
```
    Main constructor.
- 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.
  - getExcitationFilterLink
```
protected List<LightPathExcitationFilterLink> getExcitationFilterLink()
```
    returns excitationFilterLink . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many List ome.model.acquisition.LightPath.excitationFilterLink (ome.model.acquisition.LightPathExcitationFilterLink) Values are indexed by the column "index" on ome.model.acquisition.LightPathExcitationFilterLink
  - setExcitationFilterLink
```
protected void setExcitationFilterLink(List<LightPathExcitationFilterLink> 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<LightPathExcitationFilterLink> 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<LightPathExcitationFilterLink> 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.LightPathExcitationFilterLink 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.
  - addLightPathExcitationFilterLink
```
public void addLightPathExcitationFilterLink(LightPathExcitationFilterLink target)
```
    use instead of setExcitationFilterLink . Makes the necessary call on ome.model.acquisition.LightPathExcitationFilterLink as well.
  - addLightPathExcitationFilterLinkSet
```
public void addLightPathExcitationFilterLinkSet(Collection<LightPathExcitationFilterLink> targets)
```
    use like addLightPathExcitationFilterLink.
  - removeLightPathExcitationFilterLink
```
public void removeLightPathExcitationFilterLink(LightPathExcitationFilterLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.acquisition.LightPathExcitationFilterLink
  - removeLightPathExcitationFilterLinkSet
```
public void removeLightPathExcitationFilterLinkSet(Collection<LightPathExcitationFilterLink> targets)
```
    use like removeLightPathExcitationFilterLink
  - getLightPathExcitationFilterLink
```
public LightPathExcitationFilterLink getLightPathExcitationFilterLink(int index)
                                                               throws IndexOutOfBoundsException
```
    Gets the ome.model.acquisition.LightPathExcitationFilterLink at the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - setLightPathExcitationFilterLink
```
public LightPathExcitationFilterLink setLightPathExcitationFilterLink(int index,
                                                                      LightPathExcitationFilterLink element)
                                                               throws IndexOutOfBoundsException
```
    Sets the ome.model.acquisition.LightPathExcitationFilterLink at the given index. Adheres to the List.set(int, Object) contract. To extend the list, use addLightPathExcitationFilterLink(LightPathExcitationFilterLink).
    
    Throws:
    
    IndexOutOfBoundsException
    
    See Also:
    
    List.set(int, Object)
  - getPrimaryLightPathExcitationFilterLink
```
public LightPathExcitationFilterLink getPrimaryLightPathExcitationFilterLink()
                                                                      throws IndexOutOfBoundsException
```
    Gets the first element of excitationFilterLink which can be interpreted as the primary or default element in some situations. If there is not first element, an IndexOutOfBoundsException is throws. This method will also throw an ApiUsageException if the collection is unloaded. See sizeOfExcitationFilterLink() for more information.
    
    Throws:
    
    IndexOutOfBoundsException
  - setPrimaryLightPathExcitationFilterLink
```
public LightPathExcitationFilterLink setPrimaryLightPathExcitationFilterLink(LightPathExcitationFilterLink element)
                                                                      throws IndexOutOfBoundsException
```
    Swaps the first element of excitationFilterLink with the first instance of the given element. If the given element is not in the list, an IndexOutOfBoundsException will be thrown. Returns the swapped element. This method will also throw an ApiUsageException if the collection is unloaded. See sizeOfExcitationFilterLink() for more information.
    
    Throws:
    
    IndexOutOfBoundsException
  - linkExcitationFilter
```
public LightPathExcitationFilterLink linkExcitationFilter(Filter addition)
```
    Adds a ome.model.acquisition.LightPathExcitationFilterLink to excitationFilterLink . This entails changing our excitationFilterLink Set, creating a new ome.model.acquisition.LightPathExcitationFilterLink and calling linkExcitationFilter on the ome.model.acquisition.Filter.
  - addLightPathExcitationFilterLink
```
public void addLightPathExcitationFilterLink(LightPathExcitationFilterLink link,
                                             boolean bothSides)
```
    Adds a ome.model.acquisition.LightPathExcitationFilterLink to excitationFilterLink, allowing for recursion -- whether or not addLightPathExcitationFilterLink will be called on the addition if it is loaded
  - linkedExcitationFilterIterator
```
public 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 an ConcurrentModificationException. Use linkedExcitationFilterList() instead.
  - findLightPathExcitationFilterLink
```
public Set<LightPathExcitationFilterLink> findLightPathExcitationFilterLink(Filter target)
```
    find all ome.model.acquisition.LightPathExcitationFilterLink which have the argument as their child.
  - linkedExcitationFilterList
```
public List<Filter> 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.Filter while collecting the results. If block == null, then the iterator values themselves are collected.
  - unlinkExcitationFilter
```
public void unlinkExcitationFilter(Filter removal)
```
    unlinks all ome.model.acquisition.Filter instances from this instance.
  - removeLightPathExcitationFilterLink
```
public void removeLightPathExcitationFilterLink(LightPathExcitationFilterLink link,
                                                boolean bothSides)
```
    removes the given LightPathExcitationFilterLink from excitationFilterLink, allowing for recursion -- whether or not the removal will call unlinkLightPath 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.LightPathExcitationFilterLink 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.LightPath.dichroic (ome.model.acquisition.Dichroic)
  - setDichroic
```
public void setDichroic(Dichroic dichroic)
```
  - getEmissionFilterLink
```
protected Set<LightPathEmissionFilterLink> 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.LightPath.emissionFilterLink (ome.model.acquisition.LightPathEmissionFilterLink)
  - setEmissionFilterLink
```
protected void setEmissionFilterLink(Set<LightPathEmissionFilterLink> 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<LightPathEmissionFilterLink> 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<LightPathEmissionFilterLink> 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.LightPathEmissionFilterLink 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.
  - addLightPathEmissionFilterLink
```
public void addLightPathEmissionFilterLink(LightPathEmissionFilterLink target)
```
    use instead of setEmissionFilterLink . Makes the necessary call on ome.model.acquisition.LightPathEmissionFilterLink as well.
  - addLightPathEmissionFilterLinkSet
```
public void addLightPathEmissionFilterLinkSet(Collection<LightPathEmissionFilterLink> targets)
```
    use like addLightPathEmissionFilterLink.
  - removeLightPathEmissionFilterLink
```
public void removeLightPathEmissionFilterLink(LightPathEmissionFilterLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.acquisition.LightPathEmissionFilterLink
  - removeLightPathEmissionFilterLinkSet
```
public void removeLightPathEmissionFilterLinkSet(Collection<LightPathEmissionFilterLink> targets)
```
    use like removeLightPathEmissionFilterLink
  - linkEmissionFilter
```
public LightPathEmissionFilterLink linkEmissionFilter(Filter addition)
```
    Adds a ome.model.acquisition.LightPathEmissionFilterLink to emissionFilterLink . This entails changing our emissionFilterLink Set, creating a new ome.model.acquisition.LightPathEmissionFilterLink and calling linkEmissionFilter on the ome.model.acquisition.Filter.
  - addLightPathEmissionFilterLink
```
public void addLightPathEmissionFilterLink(LightPathEmissionFilterLink link,
                                           boolean bothSides)
```
    Adds a ome.model.acquisition.LightPathEmissionFilterLink to emissionFilterLink, allowing for recursion -- whether or not addLightPathEmissionFilterLink will be called on the addition if it is loaded
  - linkedEmissionFilterIterator
```
public 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 an ConcurrentModificationException. Use linkedEmissionFilterList() instead.
  - findLightPathEmissionFilterLink
```
public Set<LightPathEmissionFilterLink> findLightPathEmissionFilterLink(Filter target)
```
    find all ome.model.acquisition.LightPathEmissionFilterLink which have the argument as their child.
  - linkedEmissionFilterList
```
public List<Filter> 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.Filter while collecting the results. If block == null, then the iterator values themselves are collected.
  - unlinkEmissionFilter
```
public void unlinkEmissionFilter(Filter removal)
```
    unlinks all ome.model.acquisition.Filter instances from this instance.
  - removeLightPathEmissionFilterLink
```
public void removeLightPathEmissionFilterLink(LightPathEmissionFilterLink link,
                                              boolean bothSides)
```
    removes the given LightPathEmissionFilterLink from emissionFilterLink, allowing for recursion -- whether or not the removal will call unlinkLightPath 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.LightPathEmissionFilterLink that a user has. If unfetched, returns null. No entries in the collection should be null.
  - getAnnotationLinks
```
protected Set<LightPathAnnotationLink> 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.LightPath.annotationLinks (ome.model.annotations.LightPathAnnotationLink)
  - setAnnotationLinks
```
protected void setAnnotationLinks(Set<LightPathAnnotationLink> 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<LightPathAnnotationLink> 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<LightPathAnnotationLink> 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.LightPathAnnotationLink 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
  - addLightPathAnnotationLink
```
public void addLightPathAnnotationLink(LightPathAnnotationLink target)
```
    use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.LightPathAnnotationLink as well.
  - addLightPathAnnotationLinkSet
```
public void addLightPathAnnotationLinkSet(Collection<LightPathAnnotationLink> targets)
```
    use like addLightPathAnnotationLink.
  - removeLightPathAnnotationLink
```
public void removeLightPathAnnotationLink(LightPathAnnotationLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.annotations.LightPathAnnotationLink
  - removeLightPathAnnotationLinkSet
```
public void removeLightPathAnnotationLinkSet(Collection<LightPathAnnotationLink> targets)
```
    use like removeLightPathAnnotationLink
  - linkAnnotation
```
public LightPathAnnotationLink linkAnnotation(Annotation addition)
```
    Adds a ome.model.annotations.LightPathAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.LightPathAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.
    
    Specified by:
    
    linkAnnotation in interface IAnnotated
  - addLightPathAnnotationLink
```
public void addLightPathAnnotationLink(LightPathAnnotationLink link,
                                       boolean bothSides)
```
    Adds a ome.model.annotations.LightPathAnnotationLink to annotationLinks, allowing for recursion -- whether or not addLightPathAnnotationLink 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
  - findLightPathAnnotationLink
```
public Set<LightPathAnnotationLink> findLightPathAnnotationLink(Annotation target)
```
    find all ome.model.annotations.LightPathAnnotationLink 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
  - removeLightPathAnnotationLink
```
public void removeLightPathAnnotationLink(LightPathAnnotationLink link,
                                          boolean bothSides)
```
    removes the given LightPathAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkLightPath 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.LightPathAnnotationLink 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 LightPath.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 LightPath newInstance()
```
  - proxy
```
public LightPath 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 LightPath

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

excitationFilterLink

OWNER_FILTER_EXCITATIONFILTERLINK

GROUP_FILTER_EXCITATIONFILTERLINK

EVENT_FILTER_EXCITATIONFILTERLINK

PERMS_FILTER_EXCITATIONFILTERLINK

dichroic

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

EXCITATIONFILTERLINKCOUNTPEROWNER

EXCITATIONFILTERLINK

DICHROIC

EMISSIONFILTERLINKCOUNTPEROWNER

EMISSIONFILTERLINK

ANNOTATIONLINKSCOUNTPEROWNER

ANNOTATIONLINKS

DETAILS

FIELDS

_dynamicFields

_loaded

Constructor Detail

LightPath

LightPath

LightPath

Method Detail

getId

setId

getVersion

setVersion

getExcitationFilterLink

setExcitationFilterLink

sizeOfExcitationFilterLink

iterateExcitationFilterLink

unmodifiableExcitationFilterLink

collectExcitationFilterLink

addLightPathExcitationFilterLink

addLightPathExcitationFilterLinkSet

removeLightPathExcitationFilterLink

removeLightPathExcitationFilterLinkSet

getLightPathExcitationFilterLink

setLightPathExcitationFilterLink

getPrimaryLightPathExcitationFilterLink

setPrimaryLightPathExcitationFilterLink

linkExcitationFilter

addLightPathExcitationFilterLink

linkedExcitationFilterIterator

findLightPathExcitationFilterLink

linkedExcitationFilterList

eachLinkedExcitationFilter

unlinkExcitationFilter

removeLightPathExcitationFilterLink

clearExcitationFilterLinks

setExcitationFilterLinkCountPerOwner

getExcitationFilterLinkCountPerOwner

getDichroic

setDichroic

getEmissionFilterLink