@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class Roi extends Object implements Serializable, IObject, IMutable, IAnnotated
Modifier and Type | Class and Description |
---|---|
static class |
Roi.Details |
Modifier | Constructor and Description |
---|---|
|
Roi() |
protected |
Roi(Long id) |
|
Roi(Long id,
boolean loaded)
Main constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addRoiAnnotationLink(RoiAnnotationLink target)
use instead of setAnnotationLinks .
|
void |
addRoiAnnotationLink(RoiAnnotationLink link,
boolean bothSides)
Adds a ome.model.annotations.RoiAnnotationLink to annotationLinks, allowing for recursion -- whether
or not addRoiAnnotationLink will be called on the addition if it is loaded
|
void |
addRoiAnnotationLinkSet(Collection<RoiAnnotationLink> targets)
use like addRoiAnnotationLink.
|
void |
addShape(Shape target)
use instead of setShapes .
|
void |
addShapeSet(Collection<Shape> targets)
use like addShape.
|
void |
clearAnnotationLinks()
clears the set.
|
void |
clearShapes()
clears the set.
|
<E> List<E> |
collectAnnotationLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.annotations.RoiAnnotationLink while
collecting the results.
|
<E> List<E> |
collectShapes(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.roi.Shape 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.
|
protected void |
errorIfUnloaded() |
Set<String> |
fields()
returns a Set of field names that belong to this class
|
Set<RoiAnnotationLink> |
findRoiAnnotationLink(Annotation target)
find all ome.model.annotations.RoiAnnotationLink which have the argument as their child.
|
protected Set<RoiAnnotationLink> |
getAnnotationLinks()
returns annotationLinks .
|
Map<Long,Long> |
getAnnotationLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.annotations.RoiAnnotationLink that a user has.
|
String |
getDescription()
Simple field ome.model.roi.Roi.description (java.lang.String)
|
Details |
getDetails()
The details of this object correspond to low-level system
information.
|
GraphHolder |
getGraphHolder()
retrieves the
GraphHolder for this entity. |
Long |
getId()
The DB unique identifier for this object.
|
Image |
getImage()
Many-to-one field ome.model.roi.Roi.image (ome.model.core.Image)
|
List<String[]> |
getKeywords()
Simple field ome.model.roi.Roi.keywords (java.util.List
|
String |
getName()
Simple field ome.model.roi.Roi.name (java.lang.String)
|
List<String> |
getNamespaces()
Simple field ome.model.roi.Roi.namespaces (java.util.List
|
Shape |
getPrimaryShape()
Gets the first element of shapes which can be interpreted as the
primary or default element in some situations.
|
Shape |
getShape(int index)
Gets the ome.model.roi.Shape at the given index.
|
protected List<Shape> |
getShapes()
returns shapes .
|
OriginalFile |
getSource()
Many-to-one field ome.model.roi.Roi.source (ome.model.core.OriginalFile)
|
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<RoiAnnotationLink> |
iterateAnnotationLinks()
should be used rather than accessing the annotationLinks set directly.
|
Iterator<Shape> |
iterateShapes()
should be used rather than accessing the shapes set directly.
|
RoiAnnotationLink |
linkAnnotation(Annotation addition)
Adds a ome.model.annotations.RoiAnnotationLink 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. |
Roi |
newInstance() |
Roi |
proxy() |
void |
putAt(String field,
Object value)
stores a value in this instance.
|
void |
removeRoiAnnotationLink(RoiAnnotationLink target)
removes a single element from this set and makes the inverse call on ome.model.annotations.RoiAnnotationLink
|
void |
removeRoiAnnotationLink(RoiAnnotationLink link,
boolean bothSides)
removes the given RoiAnnotationLink from annotationLinks, allowing for recursion -- whether
or not the removal will call unlinkRoi again if loaded.
|
void |
removeRoiAnnotationLinkSet(Collection<RoiAnnotationLink> targets)
use like removeRoiAnnotationLink
|
void |
removeShape(Shape target)
removes a single element from this set and makes the inverse call on ome.model.roi.Shape
|
void |
removeShapeSet(Collection<Shape> targets)
use like removeShape
|
Object |
retrieve(String field)
retrieves a value from this instance.
|
protected void |
setAnnotationLinks(Set<RoiAnnotationLink> annotationLinks)
setter for annotationLinks should be avoided.
|
protected void |
setAnnotationLinksCountPerOwner(Map<Long,Long> map) |
void |
setDescription(String description) |
protected void |
setDetails(Details details)
Use the
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the Roi.Details instance instead. |
void |
setId(Long id)
usually unneeded.
|
void |
setImage(Image image) |
void |
setKeywords(List<String[]> keywords) |
void |
setName(String name) |
void |
setNamespaces(List<String> namespaces) |
Shape |
setPrimaryShape(Shape element)
Swaps the first element of shapes with the first instance of the
given element.
|
Shape |
setShape(int index,
Shape element)
Sets the ome.model.roi.Shape at the given index.
|
protected void |
setShapes(List<Shape> shapes)
setter for shapes should be avoided.
|
void |
setSource(OriginalFile source) |
void |
setVersion(Integer version)
use with caution.
|
int |
sizeOfAnnotationLinks()
returns the size of annotationLinks.
|
int |
sizeOfShapes()
returns the size of shapes.
|
protected void |
throwNullCollectionException(String propertyName) |
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.
|
Collection<RoiAnnotationLink> |
unmodifiableAnnotationLinks()
Returns an unmodifiable collection-view
|
Collection<Shape> |
unmodifiableShapes()
Returns an unmodifiable collection-view
|
Validation |
validate()
calls the class-specific validator for this instance and returns the
Validation object. |
public static final String OWNER_FILTER
public static final String GROUP_FILTER
public static final String EVENT_FILTER
public static final String PERMS_FILTER
public static final String ID
protected Long id
public static final String VERSION
protected Integer version
protected String name
public static final String OWNER_FILTER_SHAPES
public static final String GROUP_FILTER_SHAPES
public static final String EVENT_FILTER_SHAPES
public static final String PERMS_FILTER_SHAPES
protected Image image
protected OriginalFile source
protected Set<RoiAnnotationLink> annotationLinks
public static final String OWNER_FILTER_ANNOTATIONLINKS
public static final String GROUP_FILTER_ANNOTATIONLINKS
public static final String EVENT_FILTER_ANNOTATIONLINKS
public static final String PERMS_FILTER_ANNOTATIONLINKS
protected String description
protected Details details
public static final String NAME
public static final String SHAPES
public static final String IMAGE
public static final String SOURCE
public static final String NAMESPACES
public static final String KEYWORDS
public static final String ANNOTATIONLINKSCOUNTPEROWNER
public static final String ANNOTATIONLINKS
public static final String DESCRIPTION
public static final String DETAILS
protected boolean _loaded
public Roi()
protected Roi(Long id)
public Roi(Long id, boolean loaded)
@DocumentId public Long getId()
public void setId(Long id)
IObject
public Integer getVersion()
getVersion
in interface IMutable
public void setVersion(Integer version)
IMutable
setVersion
in interface IMutable
version
- Value for this objects version.@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getName()
public void setName(String name)
protected List<Shape> getShapes()
protected void setShapes(List<Shape> shapes)
public int sizeOfShapes()
public Iterator<Shape> iterateShapes()
EmptyIterator
. To test for a null collection,
see of sizeOfShapes()
is less than zero.public Collection<Shape> unmodifiableShapes()
public <E> List<E> collectShapes(CBlock<E> block)
block == null
, then the
iterator values themselves are collected. This method uses
iterateShapes()
internally and so will return a value
even if the underlying collection is null.public void addShape(Shape target)
public void addShapeSet(Collection<Shape> targets)
public void removeShape(Shape target)
public void removeShapeSet(Collection<Shape> targets)
public void clearShapes()
public Shape getShape(int index) throws IndexOutOfBoundsException
IndexOutOfBoundsException
public Shape setShape(int index, Shape element) throws IndexOutOfBoundsException
List.set(int, Object)
contract. To extend the list, use addShape(Shape)
.IndexOutOfBoundsException
List.set(int, Object)
public Shape getPrimaryShape() throws IndexOutOfBoundsException
IndexOutOfBoundsException
is throws. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfShapes()
for more information.IndexOutOfBoundsException
public Shape setPrimaryShape(Shape element) throws IndexOutOfBoundsException
IndexOutOfBoundsException
will be thrown. Returns the swapped
element. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfShapes()
for more information.IndexOutOfBoundsException
public Image getImage()
public void setImage(Image image)
public OriginalFile getSource()
public void setSource(OriginalFile source)
public List<String> getNamespaces()
public List<String[]> getKeywords()
protected Set<RoiAnnotationLink> getAnnotationLinks()
protected void setAnnotationLinks(Set<RoiAnnotationLink> annotationLinks)
public int sizeOfAnnotationLinks()
sizeOfAnnotationLinks
in interface IAnnotated
public Iterator<RoiAnnotationLink> iterateAnnotationLinks()
EmptyIterator
. To test for a null collection,
see of sizeOfAnnotationLinks()
is less than zero.iterateAnnotationLinks
in interface IAnnotated
public Collection<RoiAnnotationLink> unmodifiableAnnotationLinks()
unmodifiableAnnotationLinks
in interface IAnnotated
public <E> List<E> collectAnnotationLinks(CBlock<E> block)
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.collectAnnotationLinks
in interface IAnnotated
public void addRoiAnnotationLink(RoiAnnotationLink target)
public void addRoiAnnotationLinkSet(Collection<RoiAnnotationLink> targets)
public void removeRoiAnnotationLink(RoiAnnotationLink target)
public void removeRoiAnnotationLinkSet(Collection<RoiAnnotationLink> targets)
public RoiAnnotationLink linkAnnotation(Annotation addition)
linkAnnotation
in interface IAnnotated
public void addRoiAnnotationLink(RoiAnnotationLink link, boolean bothSides)
public Iterator<Annotation> linkedAnnotationIterator()
ConcurrentModificationException
.
Use linkedAnnotationList()
instead.linkedAnnotationIterator
in interface IAnnotated
public Set<RoiAnnotationLink> findRoiAnnotationLink(Annotation target)
public List<Annotation> linkedAnnotationList()
List
-copy of the underlying collection. Unlike,
linkedAnnotationIterator()
, while using the returned List
,
modifications can be made to the underlying collection without throwing
ConcurrentModificationException
.linkedAnnotationList
in interface IAnnotated
public <E> List<E> eachLinkedAnnotation(CBlock<E> block)
block == null
, then the
iterator values themselves are collected.eachLinkedAnnotation
in interface IAnnotated
public void unlinkAnnotation(Annotation removal)
unlinkAnnotation
in interface IAnnotated
public void removeRoiAnnotationLink(RoiAnnotationLink link, boolean bothSides)
public void clearAnnotationLinks()
clearAnnotationLinks
in interface IAnnotated
public Map<Long,Long> getAnnotationLinksCountPerOwner()
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getDescription()
public void setDescription(String description)
public Details getDetails()
Details
type.getDetails
in interface IObject
protected void setDetails(Details details)
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the Roi.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public Roi newInstance()
public Roi proxy()
public boolean acceptFilter(Filter __filter)
acceptFilter
in interface Filterable
public Set<String> fields()
IObject
public Object retrieve(String field)
IObject
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)
public void putAt(String field, Object value)
IObject
field
which
match a field of this instance will be delegated to the accessors.
Otherwise, values will be stored in a lazy-loaded map.public boolean isLoaded()
IObject
protected void errorIfUnloaded()
public void unload()
IObject
public final GraphHolder getGraphHolder()
IObject
GraphHolder
for this entity. If the GraphHolder has
not been actively set, a new one will be instatiated.getGraphHolder
in interface IObject
protected void throwNullCollectionException(String propertyName)
Version: 5.2.0-ice35-b12
Copyright © 2015 The University of Dundee & Open Microscopy Environment. All Rights Reserved.