Well (OMERO API)

java.lang.Object
- ome.model.screen.Well

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

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`_dynamicFields`
`protected boolean`	`_loaded`
`protected Integer`	`alpha`
`static String`	`ALPHA`
`protected Set<WellAnnotationLink>`	`annotationLinks`
`static String`	`ANNOTATIONLINKS`
`static String`	`ANNOTATIONLINKSCOUNTPEROWNER`
`protected Integer`	`blue`
`static String`	`BLUE`
`protected Integer`	`column`
`static String`	`COLUMN`
`protected Details`	`details`
`static String`	`DETAILS`
`static String`	`EVENT_FILTER`
`static String`	`EVENT_FILTER_ANNOTATIONLINKS`
`static String`	`EVENT_FILTER_REAGENTLINKS`
`static String`	`EVENT_FILTER_WELLSAMPLES`
`protected String`	`externalDescription`
`static String`	`EXTERNALDESCRIPTION`
`protected String`	`externalIdentifier`
`static String`	`EXTERNALIDENTIFIER`
`static Set<String>`	`FIELDS`
`protected Integer`	`green`
`static String`	`GREEN`
`static String`	`GROUP_FILTER`
`static String`	`GROUP_FILTER_ANNOTATIONLINKS`
`static String`	`GROUP_FILTER_REAGENTLINKS`
`static String`	`GROUP_FILTER_WELLSAMPLES`
`protected Long`	`id`
`static String`	`ID`
`static String`	`OWNER_FILTER`
`static String`	`OWNER_FILTER_ANNOTATIONLINKS`
`static String`	`OWNER_FILTER_REAGENTLINKS`
`static String`	`OWNER_FILTER_WELLSAMPLES`
`static String`	`PERMS_FILTER`
`static String`	`PERMS_FILTER_ANNOTATIONLINKS`
`static String`	`PERMS_FILTER_REAGENTLINKS`
`static String`	`PERMS_FILTER_WELLSAMPLES`
`protected Plate`	`plate`
`static String`	`PLATE`
`protected Set<WellReagentLink>`	`reagentLinks`
`static String`	`REAGENTLINKS`
`static String`	`REAGENTLINKSCOUNTPEROWNER`
`protected Integer`	`red`
`static String`	`RED`
`protected Integer`	`row`
`static String`	`ROW`
`protected String`	`status`
`static String`	`STATUS`
`protected String`	`type`
`static String`	`TYPE`
`protected Integer`	`version`
`static String`	`VERSION`
`protected List<WellSample>`	`wellSamples`
`static String`	`WELLSAMPLES`

Constructor Summary

Constructors
Modifier Constructor and Description

Well()

protected Well(Long id)

Well(Long id, boolean loaded)
Main constructor.

Well(Plate _plate)

Constructors
Modifier	Constructor and Description
	`Well()`
`protected`	`Well(Long id)`
	`Well(Long id, boolean loaded)` Main constructor.
	`Well(Plate _plate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter __filter)`
`void`	`addWellAnnotationLink(WellAnnotationLink target)` use instead of setAnnotationLinks .
`void`	`addWellAnnotationLink(WellAnnotationLink link, boolean bothSides)` Adds a ome.model.annotations.WellAnnotationLink to annotationLinks, allowing for recursion -- whether or not addWellAnnotationLink will be called on the addition if it is loaded
`void`	`addWellAnnotationLinkSet(Collection<WellAnnotationLink> targets)` use like addWellAnnotationLink.
`void`	`addWellReagentLink(WellReagentLink target)` use instead of setReagentLinks .
`void`	`addWellReagentLink(WellReagentLink link, boolean bothSides)` Adds a ome.model.screen.WellReagentLink to reagentLinks, allowing for recursion -- whether or not addWellReagentLink will be called on the addition if it is loaded
`void`	`addWellReagentLinkSet(Collection<WellReagentLink> targets)` use like addWellReagentLink.
`void`	`addWellSample(WellSample target)` use instead of setWellSamples .
`void`	`addWellSampleSet(Collection<WellSample> targets)` use like addWellSample.
`void`	`clearAnnotationLinks()` clears the set.
`void`	`clearReagentLinks()` clears the set.
`void`	`clearWellSamples()` clears the set.
`<E> List<E>`	`collectAnnotationLinks(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.annotations.WellAnnotationLink while collecting the results.
`<E> List<E>`	`collectReagentLinks(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.screen.WellReagentLink while collecting the results.
`<E> List<E>`	`collectWellSamples(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.screen.WellSample 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>`	`eachLinkedReagent(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.screen.Reagent while collecting the results.
`protected void`	`errorIfUnloaded()`
`Set<String>`	`fields()` returns a Set of field names that belong to this class
`Set<WellAnnotationLink>`	`findWellAnnotationLink(Annotation target)` find all ome.model.annotations.WellAnnotationLink which have the argument as their child.
`Set<WellReagentLink>`	`findWellReagentLink(Reagent target)` find all ome.model.screen.WellReagentLink which have the argument as their child.
`Integer`	`getAlpha()` Simple field ome.model.screen.Well.alpha (java.lang.Integer)
`protected Set<WellAnnotationLink>`	`getAnnotationLinks()` returns annotationLinks .
`Map<Long,Long>`	`getAnnotationLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.annotations.WellAnnotationLink that a user has.
`Integer`	`getBlue()` Simple field ome.model.screen.Well.blue (java.lang.Integer)
`Integer`	`getColumn()` Simple field ome.model.screen.Well.column (java.lang.Integer)
`Details`	`getDetails()` The details of this object correspond to low-level system information.
`String`	`getExternalDescription()` Simple field ome.model.screen.Well.externalDescription (java.lang.String)
`String`	`getExternalIdentifier()` Simple field ome.model.screen.Well.externalIdentifier (java.lang.String)
`GraphHolder`	`getGraphHolder()` retrieves the `GraphHolder` for this entity.
`Integer`	`getGreen()` Simple field ome.model.screen.Well.green (java.lang.Integer)
`Long`	`getId()` The DB unique identifier for this object.
`Plate`	`getPlate()` Many-to-one field ome.model.screen.Well.plate (ome.model.screen.Plate)
`WellSample`	`getPrimaryWellSample()` Gets the first element of wellSamples which can be interpreted as the primary or default element in some situations.
`protected Set<WellReagentLink>`	`getReagentLinks()` returns reagentLinks .
`Map<Long,Long>`	`getReagentLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.screen.WellReagentLink that a user has.
`Integer`	`getRed()` Simple field ome.model.screen.Well.red (java.lang.Integer)
`Integer`	`getRow()` Simple field ome.model.screen.Well.row (java.lang.Integer)
`String`	`getStatus()` Simple field ome.model.screen.Well.status (java.lang.String)
`String`	`getType()` Simple field ome.model.screen.Well.type (java.lang.String)
`Integer`	`getVersion()` This version number is controlled by the database for optimisitic locking.
`WellSample`	`getWellSample(int index)` Gets the ome.model.screen.WellSample at the given index.
`protected List<WellSample>`	`getWellSamples()` returns wellSamples .
`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<WellAnnotationLink>`	`iterateAnnotationLinks()` should be used rather than accessing the annotationLinks set directly.
`Iterator<WellReagentLink>`	`iterateReagentLinks()` should be used rather than accessing the reagentLinks set directly.
`Iterator<WellSample>`	`iterateWellSamples()` should be used rather than accessing the wellSamples set directly.
`WellAnnotationLink`	`linkAnnotation(Annotation addition)` Adds a ome.model.annotations.WellAnnotationLink 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<Reagent>`	`linkedReagentIterator()` provides an iterator over the parent values of the reagentLinks.
`List<Reagent>`	`linkedReagentList()` produces a `List`-copy of the underlying collection.
`WellReagentLink`	`linkReagent(Reagent addition)` Adds a ome.model.screen.WellReagentLink to reagentLinks .
`Well`	`newInstance()`
`Well`	`proxy()`
`void`	`putAt(String field, Object value)` stores a value in this instance.
`void`	`removeWellAnnotationLink(WellAnnotationLink target)` removes a single element from this set and makes the inverse call on ome.model.annotations.WellAnnotationLink
`void`	`removeWellAnnotationLink(WellAnnotationLink link, boolean bothSides)` removes the given WellAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkWell again if loaded.
`void`	`removeWellAnnotationLinkSet(Collection<WellAnnotationLink> targets)` use like removeWellAnnotationLink
`void`	`removeWellReagentLink(WellReagentLink target)` removes a single element from this set and makes the inverse call on ome.model.screen.WellReagentLink
`void`	`removeWellReagentLink(WellReagentLink link, boolean bothSides)` removes the given WellReagentLink from reagentLinks, allowing for recursion -- whether or not the removal will call unlinkWell again if loaded.
`void`	`removeWellReagentLinkSet(Collection<WellReagentLink> targets)` use like removeWellReagentLink
`void`	`removeWellSample(WellSample target)` removes a single element from this set and makes the inverse call on ome.model.screen.WellSample
`void`	`removeWellSampleSet(Collection<WellSample> targets)` use like removeWellSample
`Object`	`retrieve(String field)` retrieves a value from this instance.
`void`	`setAlpha(Integer alpha)`
`protected void`	`setAnnotationLinks(Set<WellAnnotationLink> annotationLinks)` setter for annotationLinks should be avoided.
`protected void`	`setAnnotationLinksCountPerOwner(Map<Long,Long> map)`
`void`	`setBlue(Integer blue)`
`void`	`setColumn(Integer column)`
`protected void`	`setDetails(Details details)` Use the `Details.copy(ome.model.internal.Details)` or `Details.shallowCopy(ome.model.internal.Details)` methods to set the `Well.Details` instance instead.
`void`	`setExternalDescription(String externalDescription)`
`void`	`setExternalIdentifier(String externalIdentifier)`
`void`	`setGreen(Integer green)`
`void`	`setId(Long id)` usually unneeded.
`void`	`setPlate(Plate plate)`
`WellSample`	`setPrimaryWellSample(WellSample element)` Swaps the first element of wellSamples with the first instance of the given element.
`protected void`	`setReagentLinks(Set<WellReagentLink> reagentLinks)` setter for reagentLinks should be avoided.
`protected void`	`setReagentLinksCountPerOwner(Map<Long,Long> map)`
`void`	`setRed(Integer red)`
`void`	`setRow(Integer row)`
`void`	`setStatus(String status)`
`void`	`setType(String type)`
`void`	`setVersion(Integer version)` use with caution.
`WellSample`	`setWellSample(int index, WellSample element)` Sets the ome.model.screen.WellSample at the given index.
`protected void`	`setWellSamples(List<WellSample> wellSamples)` setter for wellSamples should be avoided.
`int`	`sizeOfAnnotationLinks()` returns the size of annotationLinks.
`int`	`sizeOfReagentLinks()` returns the size of reagentLinks.
`int`	`sizeOfWellSamples()` returns the size of wellSamples.
`protected void`	`throwNullCollectionException(String propertyName)`
`String`	`toString()`
`void`	`unlinkAnnotation(Annotation removal)` unlinks all ome.model.annotations.Annotation instances from this instance.
`void`	`unlinkReagent(Reagent removal)` unlinks all ome.model.screen.Reagent instances from this instance.
`void`	`unload()` set the loaded field to false, and set all non-ID fields to null.
`Collection<WellAnnotationLink>`	`unmodifiableAnnotationLinks()` Returns an unmodifiable collection-view
`Collection<WellReagentLink>`	`unmodifiableReagentLinks()` Returns an unmodifiable collection-view
`Collection<WellSample>`	`unmodifiableWellSamples()` 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
```
  - status
```
protected String status
```
  - column
```
protected Integer column
```
  - row
```
protected Integer row
```
  - red
```
protected Integer red
```
  - green
```
protected Integer green
```
  - blue
```
protected Integer blue
```
  - alpha
```
protected Integer alpha
```
  - reagentLinks
```
protected Set<WellReagentLink> reagentLinks
```
  - OWNER_FILTER_REAGENTLINKS
```
public static final String OWNER_FILTER_REAGENTLINKS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_REAGENTLINKS
```
public static final String GROUP_FILTER_REAGENTLINKS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_REAGENTLINKS
```
public static final String EVENT_FILTER_REAGENTLINKS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_REAGENTLINKS
```
public static final String PERMS_FILTER_REAGENTLINKS
```
    See Also:
    
    Constant Field Values
  - externalDescription
```
protected String externalDescription
```
  - externalIdentifier
```
protected String externalIdentifier
```
  - type
```
protected String type
```
  - wellSamples
```
protected List<WellSample> wellSamples
```
  - OWNER_FILTER_WELLSAMPLES
```
public static final String OWNER_FILTER_WELLSAMPLES
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_WELLSAMPLES
```
public static final String GROUP_FILTER_WELLSAMPLES
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_WELLSAMPLES
```
public static final String EVENT_FILTER_WELLSAMPLES
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_WELLSAMPLES
```
public static final String PERMS_FILTER_WELLSAMPLES
```
    See Also:
    
    Constant Field Values
  - plate
```
protected Plate plate
```
  - annotationLinks
```
protected Set<WellAnnotationLink> 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
```
  - STATUS
```
public static final String STATUS
```
    See Also:
    
    Constant Field Values
  - COLUMN
```
public static final String COLUMN
```
    See Also:
    
    Constant Field Values
  - ROW
```
public static final String ROW
```
    See Also:
    
    Constant Field Values
  - RED
```
public static final String RED
```
    See Also:
    
    Constant Field Values
  - GREEN
```
public static final String GREEN
```
    See Also:
    
    Constant Field Values
  - BLUE
```
public static final String BLUE
```
    See Also:
    
    Constant Field Values
  - ALPHA
```
public static final String ALPHA
```
    See Also:
    
    Constant Field Values
  - REAGENTLINKSCOUNTPEROWNER
```
public static final String REAGENTLINKSCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - REAGENTLINKS
```
public static final String REAGENTLINKS
```
    See Also:
    
    Constant Field Values
  - EXTERNALDESCRIPTION
```
public static final String EXTERNALDESCRIPTION
```
    See Also:
    
    Constant Field Values
  - EXTERNALIDENTIFIER
```
public static final String EXTERNALIDENTIFIER
```
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final String TYPE
```
    See Also:
    
    Constant Field Values
  - WELLSAMPLES
```
public static final String WELLSAMPLES
```
    See Also:
    
    Constant Field Values
  - PLATE
```
public static final String PLATE
```
    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
  - Well
```
public Well()
```
  - Well
```
protected Well(Long id)
```
  - Well
```
public Well(Long id,
            boolean loaded)
```
    Main constructor.
  - Well
```
public Well(Plate _plate)
```
- 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.
  - getStatus
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getStatus()
```
    Simple field ome.model.screen.Well.status (java.lang.String)
  - setStatus
```
public void setStatus(String status)
```
  - getColumn
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getColumn()
```
    Simple field ome.model.screen.Well.column (java.lang.Integer)
  - setColumn
```
public void setColumn(Integer column)
```
  - getRow
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getRow()
```
    Simple field ome.model.screen.Well.row (java.lang.Integer)
  - setRow
```
public void setRow(Integer row)
```
  - getRed
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getRed()
```
    Simple field ome.model.screen.Well.red (java.lang.Integer)
  - setRed
```
public void setRed(Integer red)
```
  - getGreen
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getGreen()
```
    Simple field ome.model.screen.Well.green (java.lang.Integer)
  - setGreen
```
public void setGreen(Integer green)
```
  - getBlue
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getBlue()
```
    Simple field ome.model.screen.Well.blue (java.lang.Integer)
  - setBlue
```
public void setBlue(Integer blue)
```
  - getAlpha
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getAlpha()
```
    Simple field ome.model.screen.Well.alpha (java.lang.Integer)
  - setAlpha
```
public void setAlpha(Integer alpha)
```
  - getReagentLinks
```
protected Set<WellReagentLink> getReagentLinks()
```
    returns reagentLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.screen.Well.reagentLinks (ome.model.screen.WellReagentLink)
  - setReagentLinks
```
protected void setReagentLinks(Set<WellReagentLink> reagentLinks)
```
    setter for reagentLinks should be avoided. Does not fulfill normal semantics.
  - sizeOfReagentLinks
```
public int sizeOfReagentLinks()
```
    returns the size of reagentLinks. If less than zero, the Set was null.
  - iterateReagentLinks
```
public Iterator<WellReagentLink> iterateReagentLinks()
```
    should be used rather than accessing the reagentLinks set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfReagentLinks() is less than zero.
  - unmodifiableReagentLinks
```
public Collection<WellReagentLink> unmodifiableReagentLinks()
```
    Returns an unmodifiable collection-view
  - collectReagentLinks
```
public <E> List<E> collectReagentLinks(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.screen.WellReagentLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateReagentLinks() internally and so will return a value even if the underlying collection is null.
  - addWellReagentLink
```
public void addWellReagentLink(WellReagentLink target)
```
    use instead of setReagentLinks . Makes the necessary call on ome.model.screen.WellReagentLink as well.
  - addWellReagentLinkSet
```
public void addWellReagentLinkSet(Collection<WellReagentLink> targets)
```
    use like addWellReagentLink.
  - removeWellReagentLink
```
public void removeWellReagentLink(WellReagentLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.screen.WellReagentLink
  - removeWellReagentLinkSet
```
public void removeWellReagentLinkSet(Collection<WellReagentLink> targets)
```
    use like removeWellReagentLink
  - linkReagent
```
public WellReagentLink linkReagent(Reagent addition)
```
    Adds a ome.model.screen.WellReagentLink to reagentLinks . This entails changing our reagentLinks Set, creating a new ome.model.screen.WellReagentLink and calling linkReagent on the ome.model.screen.Reagent.
  - addWellReagentLink
```
public void addWellReagentLink(WellReagentLink link,
                               boolean bothSides)
```
    Adds a ome.model.screen.WellReagentLink to reagentLinks, allowing for recursion -- whether or not addWellReagentLink will be called on the addition if it is loaded
  - linkedReagentIterator
```
public Iterator<Reagent> linkedReagentIterator()
```
    provides an iterator over the parent values of the reagentLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedReagentList() instead.
  - findWellReagentLink
```
public Set<WellReagentLink> findWellReagentLink(Reagent target)
```
    find all ome.model.screen.WellReagentLink which have the argument as their child.
  - linkedReagentList
```
public List<Reagent> linkedReagentList()
```
    produces a List-copy of the underlying collection. Unlike, linkedReagentIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
  - eachLinkedReagent
```
public <E> List<E> eachLinkedReagent(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.screen.Reagent while collecting the results. If block == null, then the iterator values themselves are collected.
  - unlinkReagent
```
public void unlinkReagent(Reagent removal)
```
    unlinks all ome.model.screen.Reagent instances from this instance.
  - removeWellReagentLink
```
public void removeWellReagentLink(WellReagentLink link,
                                  boolean bothSides)
```
    removes the given WellReagentLink from reagentLinks, allowing for recursion -- whether or not the removal will call unlinkWell again if loaded.
  - clearReagentLinks
```
public void clearReagentLinks()
```
    clears the set.
  - setReagentLinksCountPerOwner
```
protected void setReagentLinksCountPerOwner(Map<Long,Long> map)
```
  - getReagentLinksCountPerOwner
```
public Map<Long,Long> getReagentLinksCountPerOwner()
```
    If fetched, returns the count(*) of ome.model.screen.WellReagentLink that a user has. If unfetched, returns null. No entries in the collection should be null.
  - getExternalDescription
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getExternalDescription()
```
    Simple field ome.model.screen.Well.externalDescription (java.lang.String)
  - setExternalDescription
```
public void setExternalDescription(String externalDescription)
```
  - getExternalIdentifier
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getExternalIdentifier()
```
    Simple field ome.model.screen.Well.externalIdentifier (java.lang.String)
  - setExternalIdentifier
```
public void setExternalIdentifier(String externalIdentifier)
```
  - getType
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getType()
```
    Simple field ome.model.screen.Well.type (java.lang.String)
  - setType
```
public void setType(String type)
```
  - getWellSamples
```
protected List<WellSample> getWellSamples()
```
    returns wellSamples . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many List ome.model.screen.Well.wellSamples (ome.model.screen.WellSample) Values are indexed by the column "index" on ome.model.screen.WellSample
  - setWellSamples
```
protected void setWellSamples(List<WellSample> wellSamples)
```
    setter for wellSamples should be avoided. Does not fulfill normal semantics.
  - sizeOfWellSamples
```
public int sizeOfWellSamples()
```
    returns the size of wellSamples. If less than zero, the Set was null.
  - iterateWellSamples
```
public Iterator<WellSample> iterateWellSamples()
```
    should be used rather than accessing the wellSamples set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfWellSamples() is less than zero.
  - unmodifiableWellSamples
```
public Collection<WellSample> unmodifiableWellSamples()
```
    Returns an unmodifiable collection-view
  - collectWellSamples
```
public <E> List<E> collectWellSamples(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.screen.WellSample while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateWellSamples() internally and so will return a value even if the underlying collection is null.
  - addWellSample
```
public void addWellSample(WellSample target)
```
    use instead of setWellSamples . Makes the necessary call on ome.model.screen.WellSample as well.
  - addWellSampleSet
```
public void addWellSampleSet(Collection<WellSample> targets)
```
    use like addWellSample.
  - removeWellSample
```
public void removeWellSample(WellSample target)
```
    removes a single element from this set and makes the inverse call on ome.model.screen.WellSample
  - removeWellSampleSet
```
public void removeWellSampleSet(Collection<WellSample> targets)
```
    use like removeWellSample
  - clearWellSamples
```
public void clearWellSamples()
```
    clears the set.
  - getWellSample
```
public WellSample getWellSample(int index)
                         throws IndexOutOfBoundsException
```
    Gets the ome.model.screen.WellSample at the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - setWellSample
```
public WellSample setWellSample(int index,
                                WellSample element)
                         throws IndexOutOfBoundsException
```
    Sets the ome.model.screen.WellSample at the given index. Adheres to the List.set(int, Object) contract. To extend the list, use addWellSample(WellSample).
    
    Throws:
    
    IndexOutOfBoundsException
    
    See Also:
    
    List.set(int, Object)
  - getPrimaryWellSample
```
public WellSample getPrimaryWellSample()
                                throws IndexOutOfBoundsException
```
    Gets the first element of wellSamples 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 sizeOfWellSamples() for more information.
    
    Throws:
    
    IndexOutOfBoundsException
  - setPrimaryWellSample
```
public WellSample setPrimaryWellSample(WellSample element)
                                throws IndexOutOfBoundsException
```
    Swaps the first element of wellSamples 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 sizeOfWellSamples() for more information.
    
    Throws:
    
    IndexOutOfBoundsException
  - getPlate
```
public Plate getPlate()
```
    Many-to-one field ome.model.screen.Well.plate (ome.model.screen.Plate)
  - setPlate
```
public void setPlate(Plate plate)
```
  - getAnnotationLinks
```
protected Set<WellAnnotationLink> 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.screen.Well.annotationLinks (ome.model.annotations.WellAnnotationLink)
  - setAnnotationLinks
```
protected void setAnnotationLinks(Set<WellAnnotationLink> 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<WellAnnotationLink> 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<WellAnnotationLink> 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.WellAnnotationLink 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
  - addWellAnnotationLink
```
public void addWellAnnotationLink(WellAnnotationLink target)
```
    use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.WellAnnotationLink as well.
  - addWellAnnotationLinkSet
```
public void addWellAnnotationLinkSet(Collection<WellAnnotationLink> targets)
```
    use like addWellAnnotationLink.
  - removeWellAnnotationLink
```
public void removeWellAnnotationLink(WellAnnotationLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.annotations.WellAnnotationLink
  - removeWellAnnotationLinkSet
```
public void removeWellAnnotationLinkSet(Collection<WellAnnotationLink> targets)
```
    use like removeWellAnnotationLink
  - linkAnnotation
```
public WellAnnotationLink linkAnnotation(Annotation addition)
```
    Adds a ome.model.annotations.WellAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.WellAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.
    
    Specified by:
    
    linkAnnotation in interface IAnnotated
  - addWellAnnotationLink
```
public void addWellAnnotationLink(WellAnnotationLink link,
                                  boolean bothSides)
```
    Adds a ome.model.annotations.WellAnnotationLink to annotationLinks, allowing for recursion -- whether or not addWellAnnotationLink 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
  - findWellAnnotationLink
```
public Set<WellAnnotationLink> findWellAnnotationLink(Annotation target)
```
    find all ome.model.annotations.WellAnnotationLink 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
  - removeWellAnnotationLink
```
public void removeWellAnnotationLink(WellAnnotationLink link,
                                     boolean bothSides)
```
    removes the given WellAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkWell 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.WellAnnotationLink 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 subclasse 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 Well.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 Well newInstance()
```
  - proxy
```
public Well 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 Well

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

status

column

row

red

green

blue

alpha

reagentLinks

OWNER_FILTER_REAGENTLINKS

GROUP_FILTER_REAGENTLINKS

EVENT_FILTER_REAGENTLINKS

PERMS_FILTER_REAGENTLINKS

externalDescription

externalIdentifier

type

wellSamples

OWNER_FILTER_WELLSAMPLES

GROUP_FILTER_WELLSAMPLES

EVENT_FILTER_WELLSAMPLES

PERMS_FILTER_WELLSAMPLES

plate

annotationLinks

OWNER_FILTER_ANNOTATIONLINKS

GROUP_FILTER_ANNOTATIONLINKS

EVENT_FILTER_ANNOTATIONLINKS

PERMS_FILTER_ANNOTATIONLINKS

details

STATUS

COLUMN

ROW

RED

GREEN

BLUE

ALPHA

REAGENTLINKSCOUNTPEROWNER

REAGENTLINKS

EXTERNALDESCRIPTION

EXTERNALIDENTIFIER

TYPE

WELLSAMPLES

PLATE

ANNOTATIONLINKSCOUNTPEROWNER

ANNOTATIONLINKS

DETAILS

FIELDS

_dynamicFields

_loaded

Constructor Detail

Well

Well

Well

Well

Method Detail

getId

setId

getVersion

setVersion

getStatus

setStatus

getColumn

setColumn

getRow

setRow

getRed

setRed