Shape (omero-model 5.6.7 API)

java.lang.Object
- ome.model.roi.Shape

All Implemented Interfaces:

java.io.Serializable, IAnnotated, IMutable, IObject, Filterable

Direct Known Subclasses:

Ellipse, Label, Line, Mask, Path, Point, Polygon, Polyline, Rectangle
```
@Entity
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public abstract class Shape
extends java.lang.Object
implements java.io.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 Shape.Details

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,java.lang.Object>`	`_dynamicFields`
`protected boolean`	`_loaded`
`protected java.util.Set<ShapeAnnotationLink>`	`annotationLinks`
`static java.lang.String`	`ANNOTATIONLINKS`
`static java.lang.String`	`ANNOTATIONLINKSCOUNTPEROWNER`
`protected Details`	`details`
`static java.lang.String`	`DETAILS`
`static java.lang.String`	`EVENT_FILTER`
`static java.lang.String`	`EVENT_FILTER_ANNOTATIONLINKS`
`static java.util.Set<java.lang.String>`	`FIELDS`
`protected java.lang.Integer`	`fillColor`
`static java.lang.String`	`FILLCOLOR`
`protected java.lang.String`	`fillRule`
`static java.lang.String`	`FILLRULE`
`protected java.lang.String`	`fontFamily`
`static java.lang.String`	`FONTFAMILY`
`protected Length`	`fontSize`
`static java.lang.String`	`FONTSIZE`
`protected java.lang.String`	`fontStyle`
`static java.lang.String`	`FONTSTYLE`
`static java.lang.String`	`GROUP_FILTER`
`static java.lang.String`	`GROUP_FILTER_ANNOTATIONLINKS`
`protected java.lang.Long`	`id`
`static java.lang.String`	`ID`
`protected java.lang.Boolean`	`locked`
`static java.lang.String`	`LOCKED`
`static java.lang.String`	`OWNER_FILTER`
`static java.lang.String`	`OWNER_FILTER_ANNOTATIONLINKS`
`static java.lang.String`	`PERMS_FILTER`
`static java.lang.String`	`PERMS_FILTER_ANNOTATIONLINKS`
`protected Roi`	`roi`
`static java.lang.String`	`ROI`
`protected java.lang.Integer`	`strokeColor`
`static java.lang.String`	`STROKECOLOR`
`protected java.lang.String`	`strokeDashArray`
`static java.lang.String`	`STROKEDASHARRAY`
`protected Length`	`strokeWidth`
`static java.lang.String`	`STROKEWIDTH`
`protected java.lang.Integer`	`theC`
`static java.lang.String`	`THEC`
`protected java.lang.Integer`	`theT`
`static java.lang.String`	`THET`
`protected java.lang.Integer`	`theZ`
`static java.lang.String`	`THEZ`
`protected AffineTransform`	`transform`
`static java.lang.String`	`TRANSFORM`
`protected java.lang.Integer`	`version`
`static java.lang.String`	`VERSION`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Shape()`
`protected`	`Shape(java.lang.Long id)`
	`Shape(java.lang.Long id, boolean loaded)` Main constructor.
	`Shape(Roi _roi)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter __filter)`
`void`	`addShapeAnnotationLink(ShapeAnnotationLink target)` use instead of setAnnotationLinks .
`void`	`addShapeAnnotationLink(ShapeAnnotationLink link, boolean bothSides)` Adds a ome.model.annotations.ShapeAnnotationLink to annotationLinks, allowing for recursion -- whether or not addShapeAnnotationLink will be called on the addition if it is loaded
`void`	`addShapeAnnotationLinkSet(java.util.Collection<ShapeAnnotationLink> targets)` use like addShapeAnnotationLink.
`void`	`clearAnnotationLinks()` clears the set.
`<E> java.util.List<E>`	`collectAnnotationLinks(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.annotations.ShapeAnnotationLink while collecting the results.
`<E> java.util.List<E>`	`eachLinkedAnnotation(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results.
`protected void`	`errorIfUnloaded()`
`java.util.Set<java.lang.String>`	`fields()` returns a Set of field names that belong to this class
`java.util.Set<ShapeAnnotationLink>`	`findShapeAnnotationLink(Annotation target)` find all ome.model.annotations.ShapeAnnotationLink which have the argument as their child.
`protected java.util.Set<ShapeAnnotationLink>`	`getAnnotationLinks()` returns annotationLinks .
`java.util.Map<java.lang.Long,java.lang.Long>`	`getAnnotationLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.annotations.ShapeAnnotationLink that a user has.
`Details`	`getDetails()` The details of this object correspond to low-level system information.
`java.lang.Integer`	`getFillColor()` Simple field ome.model.roi.Shape.fillColor (java.lang.Integer)
`java.lang.String`	`getFillRule()` Simple field ome.model.roi.Shape.fillRule (java.lang.String)
`java.lang.String`	`getFontFamily()` Simple field ome.model.roi.Shape.fontFamily (java.lang.String)
`Length`	`getFontSize()` Enum-mapped unit-based field ome.model.roi.Shape.fontSize (ome.model.units.Length)
`java.lang.String`	`getFontStyle()` Simple field ome.model.roi.Shape.fontStyle (java.lang.String)
`GraphHolder`	`getGraphHolder()` retrieves the `GraphHolder` for this entity.
`java.lang.Long`	`getId()` The DB unique identifier for this object.
`java.lang.Boolean`	`getLocked()` Simple field ome.model.roi.Shape.locked (java.lang.Boolean)
`Roi`	`getRoi()` Many-to-one field ome.model.roi.Shape.roi (ome.model.roi.Roi)
`java.lang.Integer`	`getStrokeColor()` Simple field ome.model.roi.Shape.strokeColor (java.lang.Integer)
`java.lang.String`	`getStrokeDashArray()` Simple field ome.model.roi.Shape.strokeDashArray (java.lang.String)
`Length`	`getStrokeWidth()` Enum-mapped unit-based field ome.model.roi.Shape.strokeWidth (ome.model.units.Length)
`java.lang.Integer`	`getTheC()` Simple field ome.model.roi.Shape.theC (java.lang.Integer)
`java.lang.Integer`	`getTheT()` Simple field ome.model.roi.Shape.theT (java.lang.Integer)
`java.lang.Integer`	`getTheZ()` Simple field ome.model.roi.Shape.theZ (java.lang.Integer)
`AffineTransform`	`getTransform()` Many-to-one field ome.model.roi.Shape.transform (ome.model.roi.AffineTransform)
`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 from `Validation.isValid()`
`java.util.Iterator<ShapeAnnotationLink>`	`iterateAnnotationLinks()` should be used rather than accessing the annotationLinks set directly.
`ShapeAnnotationLink`	`linkAnnotation(Annotation addition)` Adds a ome.model.annotations.ShapeAnnotationLink to annotationLinks .
`java.util.Iterator<Annotation>`	`linkedAnnotationIterator()` provides an iterator over the parent values of the annotationLinks.
`java.util.List<Annotation>`	`linkedAnnotationList()` produces a `List`-copy of the underlying collection.
`void`	`putAt(java.lang.String field, java.lang.Object value)` stores a value in this instance.
`void`	`removeShapeAnnotationLink(ShapeAnnotationLink target)` removes a single element from this set and makes the inverse call on ome.model.annotations.ShapeAnnotationLink
`void`	`removeShapeAnnotationLink(ShapeAnnotationLink link, boolean bothSides)` removes the given ShapeAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkShape again if loaded.
`void`	`removeShapeAnnotationLinkSet(java.util.Collection<ShapeAnnotationLink> targets)` use like removeShapeAnnotationLink
`java.lang.Object`	`retrieve(java.lang.String field)` retrieves a value from this instance.
`protected void`	`setAnnotationLinks(java.util.Set<ShapeAnnotationLink> annotationLinks)` setter for annotationLinks should be avoided.
`protected void`	`setAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)`
`protected void`	`setDetails(Details details)`
`void`	`setFillColor(java.lang.Integer fillColor)`
`void`	`setFillRule(java.lang.String fillRule)`
`void`	`setFontFamily(java.lang.String fontFamily)`
`void`	`setFontSize(Length fontSize)`
`void`	`setFontStyle(java.lang.String fontStyle)`
`void`	`setId(java.lang.Long id)` usually unneeded.
`void`	`setLocked(java.lang.Boolean locked)`
`void`	`setRoi(Roi roi)`
`void`	`setStrokeColor(java.lang.Integer strokeColor)`
`void`	`setStrokeDashArray(java.lang.String strokeDashArray)`
`void`	`setStrokeWidth(Length strokeWidth)`
`void`	`setTheC(java.lang.Integer theC)`
`void`	`setTheT(java.lang.Integer theT)`
`void`	`setTheZ(java.lang.Integer theZ)`
`void`	`setTransform(AffineTransform transform)`
`void`	`setVersion(java.lang.Integer version)` use with caution.
`int`	`sizeOfAnnotationLinks()` returns the size of annotationLinks.
`protected void`	`throwNullCollectionException(java.lang.String propertyName)`
`java.lang.String`	`toString()`
`void`	`unlinkAnnotation(Annotation removal)` unlinks all ome.model.annotations.Annotation instances from this instance.
`void`	`unload()` set the loaded field to false, and set all non-ID fields to null.
`java.util.Collection<ShapeAnnotationLink>`	`unmodifiableAnnotationLinks()` 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 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
```
  - theZ
```
protected java.lang.Integer theZ
```
  - theT
```
protected java.lang.Integer theT
```
  - theC
```
protected java.lang.Integer theC
```
  - roi
```
protected Roi roi
```
  - locked
```
protected java.lang.Boolean locked
```
  - transform
```
protected AffineTransform transform
```
  - fillColor
```
protected java.lang.Integer fillColor
```
  - fillRule
```
protected java.lang.String fillRule
```
  - strokeColor
```
protected java.lang.Integer strokeColor
```
  - strokeDashArray
```
protected java.lang.String strokeDashArray
```
  - strokeWidth
```
protected Length strokeWidth
```
  - fontFamily
```
protected java.lang.String fontFamily
```
  - fontSize
```
protected Length fontSize
```
  - fontStyle
```
protected java.lang.String fontStyle
```
  - annotationLinks
```
protected java.util.Set<ShapeAnnotationLink> annotationLinks
```
  - OWNER_FILTER_ANNOTATIONLINKS
```
public static final java.lang.String OWNER_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_ANNOTATIONLINKS
```
public static final java.lang.String GROUP_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_ANNOTATIONLINKS
```
public static final java.lang.String EVENT_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_ANNOTATIONLINKS
```
public static final java.lang.String PERMS_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - details
```
protected Details details
```
  - THEZ
```
public static final java.lang.String THEZ
```
    See Also:
    
    Constant Field Values
  - THET
```
public static final java.lang.String THET
```
    See Also:
    
    Constant Field Values
  - THEC
```
public static final java.lang.String THEC
```
    See Also:
    
    Constant Field Values
  - ROI
```
public static final java.lang.String ROI
```
    See Also:
    
    Constant Field Values
  - LOCKED
```
public static final java.lang.String LOCKED
```
    See Also:
    
    Constant Field Values
  - TRANSFORM
```
public static final java.lang.String TRANSFORM
```
    See Also:
    
    Constant Field Values
  - FILLCOLOR
```
public static final java.lang.String FILLCOLOR
```
    See Also:
    
    Constant Field Values
  - FILLRULE
```
public static final java.lang.String FILLRULE
```
    See Also:
    
    Constant Field Values
  - STROKECOLOR
```
public static final java.lang.String STROKECOLOR
```
    See Also:
    
    Constant Field Values
  - STROKEDASHARRAY
```
public static final java.lang.String STROKEDASHARRAY
```
    See Also:
    
    Constant Field Values
  - STROKEWIDTH
```
public static final java.lang.String STROKEWIDTH
```
    See Also:
    
    Constant Field Values
  - FONTFAMILY
```
public static final java.lang.String FONTFAMILY
```
    See Also:
    
    Constant Field Values
  - FONTSIZE
```
public static final java.lang.String FONTSIZE
```
    See Also:
    
    Constant Field Values
  - FONTSTYLE
```
public static final java.lang.String FONTSTYLE
```
    See Also:
    
    Constant Field Values
  - ANNOTATIONLINKSCOUNTPEROWNER
```
public static final java.lang.String ANNOTATIONLINKSCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - ANNOTATIONLINKS
```
public static final java.lang.String ANNOTATIONLINKS
```
    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
  - Shape
```
public Shape()
```
  - Shape
```
protected Shape(java.lang.Long id)
```
  - Shape
```
public Shape(java.lang.Long id,
             boolean loaded)
```
    Main constructor.
  - Shape
```
public Shape(Roi _roi)
```
- 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.
    
    Specified by:
    
    getId in interface IObject
    
    Returns:
    
    Long primary key. May be null.
  - setId
```
public void setId(java.lang.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 java.lang.Integer getVersion()
```
    This version number is controlled by the database for optimisitic locking.
    
    Specified by:
    
    getVersion in interface IMutable
  - 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 interface IMutable
    
    Parameters:
    
    version - Value for this objects version.
  - getTheZ
```
@Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getTheZ()
```
    Simple field ome.model.roi.Shape.theZ (java.lang.Integer)
  - setTheZ
```
public void setTheZ(java.lang.Integer theZ)
```
  - getTheT
```
@Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getTheT()
```
    Simple field ome.model.roi.Shape.theT (java.lang.Integer)
  - setTheT
```
public void setTheT(java.lang.Integer theT)
```
  - getTheC
```
@Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getTheC()
```
    Simple field ome.model.roi.Shape.theC (java.lang.Integer)
  - setTheC
```
public void setTheC(java.lang.Integer theC)
```
  - getRoi
```
public Roi getRoi()
```
    Many-to-one field ome.model.roi.Shape.roi (ome.model.roi.Roi)
  - setRoi
```
public void setRoi(Roi roi)
```
  - getLocked
```
public java.lang.Boolean getLocked()
```
    Simple field ome.model.roi.Shape.locked (java.lang.Boolean)
  - setLocked
```
public void setLocked(java.lang.Boolean locked)
```
  - getTransform
```
public AffineTransform getTransform()
```
    Many-to-one field ome.model.roi.Shape.transform (ome.model.roi.AffineTransform)
  - setTransform
```
public void setTransform(AffineTransform transform)
```
  - getFillColor
```
@Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getFillColor()
```
    Simple field ome.model.roi.Shape.fillColor (java.lang.Integer)
  - setFillColor
```
public void setFillColor(java.lang.Integer fillColor)
```
  - getFillRule
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getFillRule()
```
    Simple field ome.model.roi.Shape.fillRule (java.lang.String)
  - setFillRule
```
public void setFillRule(java.lang.String fillRule)
```
  - getStrokeColor
```
@Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getStrokeColor()
```
    Simple field ome.model.roi.Shape.strokeColor (java.lang.Integer)
  - setStrokeColor
```
public void setStrokeColor(java.lang.Integer strokeColor)
```
  - getStrokeDashArray
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getStrokeDashArray()
```
    Simple field ome.model.roi.Shape.strokeDashArray (java.lang.String)
  - setStrokeDashArray
```
public void setStrokeDashArray(java.lang.String strokeDashArray)
```
  - getStrokeWidth
```
public Length getStrokeWidth()
```
    Enum-mapped unit-based field ome.model.roi.Shape.strokeWidth (ome.model.units.Length)
  - setStrokeWidth
```
public void setStrokeWidth(Length strokeWidth)
```
  - getFontFamily
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getFontFamily()
```
    Simple field ome.model.roi.Shape.fontFamily (java.lang.String)
  - setFontFamily
```
public void setFontFamily(java.lang.String fontFamily)
```
  - getFontSize
```
public Length getFontSize()
```
    Enum-mapped unit-based field ome.model.roi.Shape.fontSize (ome.model.units.Length)
  - setFontSize
```
public void setFontSize(Length fontSize)
```
  - getFontStyle
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getFontStyle()
```
    Simple field ome.model.roi.Shape.fontStyle (java.lang.String)
  - setFontStyle
```
public void setFontStyle(java.lang.String fontStyle)
```
  - getAnnotationLinks
```
protected java.util.Set<ShapeAnnotationLink> 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.roi.Shape.annotationLinks (ome.model.annotations.ShapeAnnotationLink)
  - setAnnotationLinks
```
protected void setAnnotationLinks(java.util.Set<ShapeAnnotationLink> 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 java.util.Iterator<ShapeAnnotationLink> 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 java.util.Collection<ShapeAnnotationLink> unmodifiableAnnotationLinks()
```
    Returns an unmodifiable collection-view
    
    Specified by:
    
    unmodifiableAnnotationLinks in interface IAnnotated
  - collectAnnotationLinks
```
public <E> java.util.List<E> collectAnnotationLinks(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.annotations.ShapeAnnotationLink 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
  - addShapeAnnotationLink
```
public void addShapeAnnotationLink(ShapeAnnotationLink target)
```
    use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.ShapeAnnotationLink as well.
  - addShapeAnnotationLinkSet
```
public void addShapeAnnotationLinkSet(java.util.Collection<ShapeAnnotationLink> targets)
```
    use like addShapeAnnotationLink.
  - removeShapeAnnotationLink
```
public void removeShapeAnnotationLink(ShapeAnnotationLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.annotations.ShapeAnnotationLink
  - removeShapeAnnotationLinkSet
```
public void removeShapeAnnotationLinkSet(java.util.Collection<ShapeAnnotationLink> targets)
```
    use like removeShapeAnnotationLink
  - linkAnnotation
```
public ShapeAnnotationLink linkAnnotation(Annotation addition)
```
    Adds a ome.model.annotations.ShapeAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.ShapeAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.
    
    Specified by:
    
    linkAnnotation in interface IAnnotated
  - addShapeAnnotationLink
```
public void addShapeAnnotationLink(ShapeAnnotationLink link,
                                   boolean bothSides)
```
    Adds a ome.model.annotations.ShapeAnnotationLink to annotationLinks, allowing for recursion -- whether or not addShapeAnnotationLink will be called on the addition if it is loaded
  - linkedAnnotationIterator
```
public java.util.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
  - findShapeAnnotationLink
```
public java.util.Set<ShapeAnnotationLink> findShapeAnnotationLink(Annotation target)
```
    find all ome.model.annotations.ShapeAnnotationLink which have the argument as their child.
  - linkedAnnotationList
```
public java.util.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> java.util.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
  - removeShapeAnnotationLink
```
public void removeShapeAnnotationLink(ShapeAnnotationLink link,
                                      boolean bothSides)
```
    removes the given ShapeAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkShape again if loaded.
  - clearAnnotationLinks
```
public void clearAnnotationLinks()
```
    clears the set.
    
    Specified by:
    
    clearAnnotationLinks in interface IAnnotated
  - setAnnotationLinksCountPerOwner
```
protected void setAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
```
  - getAnnotationLinksCountPerOwner
```
public java.util.Map<java.lang.Long,java.lang.Long> getAnnotationLinksCountPerOwner()
```
    If fetched, returns the count(*) of ome.model.annotations.ShapeAnnotationLink 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)
```
  - 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.
  - acceptFilter
```
public boolean acceptFilter(Filter __filter)
```
    Specified by:
    
    acceptFilter in interface Filterable
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.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
    
    Specified by:
    
    fields in interface IObject
  - retrieve
```
public java.lang.Object retrieve(java.lang.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(java.lang.String field,
                  java.lang.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(java.lang.String propertyName)
```

Class Shape

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

theZ

theT

theC

roi

locked

transform

fillColor

fillRule

strokeColor

strokeDashArray

strokeWidth

fontFamily

fontSize

fontStyle

annotationLinks

OWNER_FILTER_ANNOTATIONLINKS

GROUP_FILTER_ANNOTATIONLINKS

EVENT_FILTER_ANNOTATIONLINKS

PERMS_FILTER_ANNOTATIONLINKS

details

THEZ

THET

THEC

ROI

LOCKED

TRANSFORM

FILLCOLOR

FILLRULE

STROKECOLOR

STROKEDASHARRAY

STROKEWIDTH

FONTFAMILY

FONTSIZE

FONTSTYLE

ANNOTATIONLINKSCOUNTPEROWNER

ANNOTATIONLINKS

DETAILS

FIELDS

_dynamicFields

_loaded

Constructor Detail

Shape

Shape

Shape

Shape

Method Detail

getId

setId

getVersion

setVersion

getTheZ

setTheZ

getTheT

setTheT

getTheC

setTheC

getRoi

setRoi

getLocked

setLocked

getTransform

setTransform

getFillColor

setFillColor

getFillRule