Package ome.model.containers
Class Folder
- java.lang.Object
-
- ome.model.containers.Folder
-
- All Implemented Interfaces:
java.io.Serializable,IAnnotated,IMutable,IObject,Filterable
@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class Folder extends java.lang.Object implements java.io.Serializable, IObject, IMutable, IAnnotatedThese filter definitions are used by the security system to eliminate non-readable objects from queries. The regular user does not need to worry about them, as they will be injected directly into the SQL (not HQL)- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFolder.Details
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<java.lang.String,java.lang.Object>_dynamicFieldsprotected boolean_loadedprotected java.util.Set<FolderAnnotationLink>annotationLinksstatic java.lang.StringANNOTATIONLINKSstatic java.lang.StringANNOTATIONLINKSCOUNTPEROWNERprotected java.util.Set<Folder>childFoldersstatic java.lang.StringCHILDFOLDERSprotected java.lang.Stringdescriptionstatic java.lang.StringDESCRIPTIONprotected Detailsdetailsstatic java.lang.StringDETAILSstatic java.lang.StringEVENT_FILTERstatic java.lang.StringEVENT_FILTER_ANNOTATIONLINKSstatic java.lang.StringEVENT_FILTER_CHILDFOLDERSstatic java.lang.StringEVENT_FILTER_IMAGELINKSstatic java.lang.StringEVENT_FILTER_ROILINKSstatic java.util.Set<java.lang.String>FIELDSstatic java.lang.StringGROUP_FILTERstatic java.lang.StringGROUP_FILTER_ANNOTATIONLINKSstatic java.lang.StringGROUP_FILTER_CHILDFOLDERSstatic java.lang.StringGROUP_FILTER_IMAGELINKSstatic java.lang.StringGROUP_FILTER_ROILINKSprotected java.lang.Longidstatic java.lang.StringIDprotected java.util.Set<FolderImageLink>imageLinksstatic java.lang.StringIMAGELINKSstatic java.lang.StringIMAGELINKSCOUNTPEROWNERprotected java.lang.Stringnamestatic java.lang.StringNAMEstatic java.lang.StringOWNER_FILTERstatic java.lang.StringOWNER_FILTER_ANNOTATIONLINKSstatic java.lang.StringOWNER_FILTER_CHILDFOLDERSstatic java.lang.StringOWNER_FILTER_IMAGELINKSstatic java.lang.StringOWNER_FILTER_ROILINKSprotected FolderparentFolderstatic java.lang.StringPARENTFOLDERstatic java.lang.StringPERMS_FILTERstatic java.lang.StringPERMS_FILTER_ANNOTATIONLINKSstatic java.lang.StringPERMS_FILTER_CHILDFOLDERSstatic java.lang.StringPERMS_FILTER_IMAGELINKSstatic java.lang.StringPERMS_FILTER_ROILINKSprotected java.util.Set<FolderRoiLink>roiLinksstatic java.lang.StringROILINKSstatic java.lang.StringROILINKSCOUNTPEROWNERprotected java.lang.Integerversionstatic java.lang.StringVERSION
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanacceptFilter(Filter __filter)voidaddChildFolders(Folder target)use instead of setChildFolders .voidaddChildFoldersSet(java.util.Collection<Folder> targets)use like addFolder.voidaddFolderAnnotationLink(FolderAnnotationLink target)use instead of setAnnotationLinks .voidaddFolderAnnotationLink(FolderAnnotationLink link, boolean bothSides)Adds a ome.model.annotations.FolderAnnotationLink to annotationLinks, allowing for recursion -- whether or not addFolderAnnotationLink will be called on the addition if it is loadedvoidaddFolderAnnotationLinkSet(java.util.Collection<FolderAnnotationLink> targets)use like addFolderAnnotationLink.voidaddFolderImageLink(FolderImageLink target)use instead of setImageLinks .voidaddFolderImageLink(FolderImageLink link, boolean bothSides)Adds a ome.model.containers.FolderImageLink to imageLinks, allowing for recursion -- whether or not addFolderImageLink will be called on the addition if it is loadedvoidaddFolderImageLinkSet(java.util.Collection<FolderImageLink> targets)use like addFolderImageLink.voidaddFolderRoiLink(FolderRoiLink target)use instead of setRoiLinks .voidaddFolderRoiLink(FolderRoiLink link, boolean bothSides)Adds a ome.model.containers.FolderRoiLink to roiLinks, allowing for recursion -- whether or not addFolderRoiLink will be called on the addition if it is loadedvoidaddFolderRoiLinkSet(java.util.Collection<FolderRoiLink> targets)use like addFolderRoiLink.voidclearAnnotationLinks()clears the set.voidclearChildFolders()clears the set.voidclearImageLinks()clears the set.voidclearRoiLinks()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.FolderAnnotationLink while collecting the results.<E> java.util.List<E>collectChildFolders(CBlock<E> block)takes a CBlock and calls the block once for each ome.model.containers.Folder while collecting the results.<E> java.util.List<E>collectImageLinks(CBlock<E> block)takes a CBlock and calls the block once for each ome.model.containers.FolderImageLink while collecting the results.<E> java.util.List<E>collectRoiLinks(CBlock<E> block)takes a CBlock and calls the block once for each ome.model.containers.FolderRoiLink 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.<E> java.util.List<E>eachLinkedImage(CBlock<E> block)takes a CBlock and calls the block once for each ome.model.core.Image while collecting the results.<E> java.util.List<E>eachLinkedRoi(CBlock<E> block)takes a CBlock and calls the block once for each ome.model.roi.Roi while collecting the results.protected voiderrorIfUnloaded()java.util.Set<java.lang.String>fields()returns a Set of field names that belong to this classjava.util.Set<FolderAnnotationLink>findFolderAnnotationLink(Annotation target)find all ome.model.annotations.FolderAnnotationLink which have the argument as their child.java.util.Set<FolderImageLink>findFolderImageLink(Image target)find all ome.model.containers.FolderImageLink which have the argument as their child.java.util.Set<FolderRoiLink>findFolderRoiLink(Roi target)find all ome.model.containers.FolderRoiLink which have the argument as their child.protected java.util.Set<FolderAnnotationLink>getAnnotationLinks()returns annotationLinks .java.util.Map<java.lang.Long,java.lang.Long>getAnnotationLinksCountPerOwner()If fetched, returns the count(*) of ome.model.annotations.FolderAnnotationLink that a user has.protected java.util.Set<Folder>getChildFolders()returns childFolders .java.lang.StringgetDescription()Simple field ome.model.containers.Folder.description (java.lang.String)DetailsgetDetails()The details of this object correspond to low-level system information.GraphHoldergetGraphHolder()retrieves theGraphHolderfor this entity.java.lang.LonggetId()The DB unique identifier for this object.protected java.util.Set<FolderImageLink>getImageLinks()returns imageLinks .java.util.Map<java.lang.Long,java.lang.Long>getImageLinksCountPerOwner()If fetched, returns the count(*) of ome.model.containers.FolderImageLink that a user has.java.lang.StringgetName()Simple field ome.model.containers.Folder.name (java.lang.String)FoldergetParentFolder()Many-to-one field ome.model.containers.Folder.parentFolder (ome.model.containers.Folder)protected java.util.Set<FolderRoiLink>getRoiLinks()returns roiLinks .java.util.Map<java.lang.Long,java.lang.Long>getRoiLinksCountPerOwner()If fetched, returns the count(*) of ome.model.containers.FolderRoiLink that a user has.java.lang.IntegergetVersion()This version number is controlled by the database for optimisitic locking.booleanisLoaded()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.booleanisValid()calls the class-specific validator for this instance and returns the value fromValidation.isValid()java.util.Iterator<FolderAnnotationLink>iterateAnnotationLinks()should be used rather than accessing the annotationLinks set directly.java.util.Iterator<Folder>iterateChildFolders()should be used rather than accessing the childFolders set directly.java.util.Iterator<FolderImageLink>iterateImageLinks()should be used rather than accessing the imageLinks set directly.java.util.Iterator<FolderRoiLink>iterateRoiLinks()should be used rather than accessing the roiLinks set directly.FolderAnnotationLinklinkAnnotation(Annotation addition)Adds a ome.model.annotations.FolderAnnotationLink to annotationLinks .java.util.Iterator<Annotation>linkedAnnotationIterator()provides an iterator over the parent values of the annotationLinks.java.util.List<Annotation>linkedAnnotationList()produces aList-copy of the underlying collection.java.util.Iterator<Image>linkedImageIterator()provides an iterator over the parent values of the imageLinks.java.util.List<Image>linkedImageList()produces aList-copy of the underlying collection.java.util.Iterator<Roi>linkedRoiIterator()provides an iterator over the parent values of the roiLinks.java.util.List<Roi>linkedRoiList()produces aList-copy of the underlying collection.FolderImageLinklinkImage(Image addition)Adds a ome.model.containers.FolderImageLink to imageLinks .FolderRoiLinklinkRoi(Roi addition)Adds a ome.model.containers.FolderRoiLink to roiLinks .FoldernewInstance()Folderproxy()voidputAt(java.lang.String field, java.lang.Object value)stores a value in this instance.voidremoveChildFolders(Folder target)removes a single element from this set and makes the inverse call on ome.model.containers.FoldervoidremoveChildFoldersSet(java.util.Collection<Folder> targets)use like removeFoldervoidremoveFolderAnnotationLink(FolderAnnotationLink target)removes a single element from this set and makes the inverse call on ome.model.annotations.FolderAnnotationLinkvoidremoveFolderAnnotationLink(FolderAnnotationLink link, boolean bothSides)removes the given FolderAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkFolder again if loaded.voidremoveFolderAnnotationLinkSet(java.util.Collection<FolderAnnotationLink> targets)use like removeFolderAnnotationLinkvoidremoveFolderImageLink(FolderImageLink target)removes a single element from this set and makes the inverse call on ome.model.containers.FolderImageLinkvoidremoveFolderImageLink(FolderImageLink link, boolean bothSides)removes the given FolderImageLink from imageLinks, allowing for recursion -- whether or not the removal will call unlinkFolder again if loaded.voidremoveFolderImageLinkSet(java.util.Collection<FolderImageLink> targets)use like removeFolderImageLinkvoidremoveFolderRoiLink(FolderRoiLink target)removes a single element from this set and makes the inverse call on ome.model.containers.FolderRoiLinkvoidremoveFolderRoiLink(FolderRoiLink link, boolean bothSides)removes the given FolderRoiLink from roiLinks, allowing for recursion -- whether or not the removal will call unlinkFolder again if loaded.voidremoveFolderRoiLinkSet(java.util.Collection<FolderRoiLink> targets)use like removeFolderRoiLinkjava.lang.Objectretrieve(java.lang.String field)retrieves a value from this instance.protected voidsetAnnotationLinks(java.util.Set<FolderAnnotationLink> annotationLinks)setter for annotationLinks should be avoided.protected voidsetAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)protected voidsetChildFolders(java.util.Set<Folder> childFolders)setter for childFolders should be avoided.voidsetDescription(java.lang.String description)protected voidsetDetails(Details details)voidsetId(java.lang.Long id)usually unneeded.protected voidsetImageLinks(java.util.Set<FolderImageLink> imageLinks)setter for imageLinks should be avoided.protected voidsetImageLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)voidsetName(java.lang.String name)voidsetParentFolder(Folder parentFolder)protected voidsetRoiLinks(java.util.Set<FolderRoiLink> roiLinks)setter for roiLinks should be avoided.protected voidsetRoiLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)voidsetVersion(java.lang.Integer version)use with caution.intsizeOfAnnotationLinks()returns the size of annotationLinks.intsizeOfChildFolders()returns the size of childFolders.intsizeOfImageLinks()returns the size of imageLinks.intsizeOfRoiLinks()returns the size of roiLinks.protected voidthrowNullCollectionException(java.lang.String propertyName)java.lang.StringtoString()voidunlinkAnnotation(Annotation removal)unlinks all ome.model.annotations.Annotation instances from this instance.voidunlinkImage(Image removal)unlinks all ome.model.core.Image instances from this instance.voidunlinkRoi(Roi removal)unlinks all ome.model.roi.Roi instances from this instance.voidunload()set the loaded field to false, and set all non-ID fields to null.java.util.Collection<FolderAnnotationLink>unmodifiableAnnotationLinks()Returns an unmodifiable collection-viewjava.util.Collection<Folder>unmodifiableChildFolders()Returns an unmodifiable collection-viewjava.util.Collection<FolderImageLink>unmodifiableImageLinks()Returns an unmodifiable collection-viewjava.util.Collection<FolderRoiLink>unmodifiableRoiLinks()Returns an unmodifiable collection-viewValidationvalidate()calls the class-specific validator for this instance and returns theValidationobject.
-
-
-
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
-
childFolders
protected java.util.Set<Folder> childFolders
-
OWNER_FILTER_CHILDFOLDERS
public static final java.lang.String OWNER_FILTER_CHILDFOLDERS
- See Also:
- Constant Field Values
-
GROUP_FILTER_CHILDFOLDERS
public static final java.lang.String GROUP_FILTER_CHILDFOLDERS
- See Also:
- Constant Field Values
-
EVENT_FILTER_CHILDFOLDERS
public static final java.lang.String EVENT_FILTER_CHILDFOLDERS
- See Also:
- Constant Field Values
-
PERMS_FILTER_CHILDFOLDERS
public static final java.lang.String PERMS_FILTER_CHILDFOLDERS
- See Also:
- Constant Field Values
-
parentFolder
protected Folder parentFolder
-
imageLinks
protected java.util.Set<FolderImageLink> imageLinks
-
OWNER_FILTER_IMAGELINKS
public static final java.lang.String OWNER_FILTER_IMAGELINKS
- See Also:
- Constant Field Values
-
GROUP_FILTER_IMAGELINKS
public static final java.lang.String GROUP_FILTER_IMAGELINKS
- See Also:
- Constant Field Values
-
EVENT_FILTER_IMAGELINKS
public static final java.lang.String EVENT_FILTER_IMAGELINKS
- See Also:
- Constant Field Values
-
PERMS_FILTER_IMAGELINKS
public static final java.lang.String PERMS_FILTER_IMAGELINKS
- See Also:
- Constant Field Values
-
roiLinks
protected java.util.Set<FolderRoiLink> roiLinks
-
OWNER_FILTER_ROILINKS
public static final java.lang.String OWNER_FILTER_ROILINKS
- See Also:
- Constant Field Values
-
GROUP_FILTER_ROILINKS
public static final java.lang.String GROUP_FILTER_ROILINKS
- See Also:
- Constant Field Values
-
EVENT_FILTER_ROILINKS
public static final java.lang.String EVENT_FILTER_ROILINKS
- See Also:
- Constant Field Values
-
PERMS_FILTER_ROILINKS
public static final java.lang.String PERMS_FILTER_ROILINKS
- See Also:
- Constant Field Values
-
annotationLinks
protected java.util.Set<FolderAnnotationLink> 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
-
name
protected java.lang.String name
-
description
protected java.lang.String description
-
details
protected Details details
-
CHILDFOLDERS
public static final java.lang.String CHILDFOLDERS
- See Also:
- Constant Field Values
-
PARENTFOLDER
public static final java.lang.String PARENTFOLDER
- See Also:
- Constant Field Values
-
IMAGELINKSCOUNTPEROWNER
public static final java.lang.String IMAGELINKSCOUNTPEROWNER
- See Also:
- Constant Field Values
-
IMAGELINKS
public static final java.lang.String IMAGELINKS
- See Also:
- Constant Field Values
-
ROILINKSCOUNTPEROWNER
public static final java.lang.String ROILINKSCOUNTPEROWNER
- See Also:
- Constant Field Values
-
ROILINKS
public static final java.lang.String ROILINKS
- 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
-
NAME
public static final java.lang.String NAME
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final java.lang.String DESCRIPTION
- 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
-
-
Method Detail
-
getId
@DocumentId public java.lang.Long getId()
The DB unique identifier for this object. You are not responsible for setting the id; however, it can be useful for creating "unloaded" versions of your objects. Each top-level entity contains an id field of type long. For all objects returned from the server, this value will be non-null, which doesn't necessarily hold for the other fields.
-
setId
public void setId(java.lang.Long id)
Description copied from interface:IObjectusually unneeded. Ids are managed by the backend.
-
getVersion
public java.lang.Integer getVersion()
This version number is controlled by the database for optimisitic locking.- Specified by:
getVersionin interfaceIMutable
-
setVersion
public void setVersion(java.lang.Integer version)
Description copied from interface:IMutableuse 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:
setVersionin interfaceIMutable- Parameters:
version- Value for this objects version.
-
getChildFolders
protected java.util.Set<Folder> getChildFolders()
returns childFolders . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.containers.Folder.childFolders (ome.model.containers.Folder)
-
setChildFolders
protected void setChildFolders(java.util.Set<Folder> childFolders)
setter for childFolders should be avoided. Does not fulfill normal semantics.
-
sizeOfChildFolders
public int sizeOfChildFolders()
returns the size of childFolders. If less than zero, the Set was null.
-
iterateChildFolders
public java.util.Iterator<Folder> iterateChildFolders()
should be used rather than accessing the childFolders set directly. This method will never return null, but rather will return an instance ofEmptyIterator. To test for a null collection, see ofsizeOfChildFolders()is less than zero.
-
unmodifiableChildFolders
public java.util.Collection<Folder> unmodifiableChildFolders()
Returns an unmodifiable collection-view
-
collectChildFolders
public <E> java.util.List<E> collectChildFolders(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.containers.Folder while collecting the results. Ifblock == null, then the iterator values themselves are collected. This method usesiterateChildFolders()internally and so will return a value even if the underlying collection is null.
-
addChildFolders
public void addChildFolders(Folder target)
use instead of setChildFolders . Makes the necessary call on ome.model.containers.Folder as well.
-
addChildFoldersSet
public void addChildFoldersSet(java.util.Collection<Folder> targets)
use like addFolder.
-
removeChildFolders
public void removeChildFolders(Folder target)
removes a single element from this set and makes the inverse call on ome.model.containers.Folder
-
removeChildFoldersSet
public void removeChildFoldersSet(java.util.Collection<Folder> targets)
use like removeFolder
-
clearChildFolders
public void clearChildFolders()
clears the set.
-
getParentFolder
public Folder getParentFolder()
Many-to-one field ome.model.containers.Folder.parentFolder (ome.model.containers.Folder)
-
setParentFolder
public void setParentFolder(Folder parentFolder)
-
getImageLinks
protected java.util.Set<FolderImageLink> getImageLinks()
returns imageLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.containers.Folder.imageLinks (ome.model.containers.FolderImageLink)
-
setImageLinks
protected void setImageLinks(java.util.Set<FolderImageLink> imageLinks)
setter for imageLinks should be avoided. Does not fulfill normal semantics.
-
sizeOfImageLinks
public int sizeOfImageLinks()
returns the size of imageLinks. If less than zero, the Set was null.
-
iterateImageLinks
public java.util.Iterator<FolderImageLink> iterateImageLinks()
should be used rather than accessing the imageLinks set directly. This method will never return null, but rather will return an instance ofEmptyIterator. To test for a null collection, see ofsizeOfImageLinks()is less than zero.
-
unmodifiableImageLinks
public java.util.Collection<FolderImageLink> unmodifiableImageLinks()
Returns an unmodifiable collection-view
-
collectImageLinks
public <E> java.util.List<E> collectImageLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.containers.FolderImageLink while collecting the results. Ifblock == null, then the iterator values themselves are collected. This method usesiterateImageLinks()internally and so will return a value even if the underlying collection is null.
-
addFolderImageLink
public void addFolderImageLink(FolderImageLink target)
use instead of setImageLinks . Makes the necessary call on ome.model.containers.FolderImageLink as well.
-
addFolderImageLinkSet
public void addFolderImageLinkSet(java.util.Collection<FolderImageLink> targets)
use like addFolderImageLink.
-
removeFolderImageLink
public void removeFolderImageLink(FolderImageLink target)
removes a single element from this set and makes the inverse call on ome.model.containers.FolderImageLink
-
removeFolderImageLinkSet
public void removeFolderImageLinkSet(java.util.Collection<FolderImageLink> targets)
use like removeFolderImageLink
-
linkImage
public FolderImageLink linkImage(Image addition)
Adds a ome.model.containers.FolderImageLink to imageLinks . This entails changing our imageLinks Set, creating a new ome.model.containers.FolderImageLink and calling linkImage on the ome.model.core.Image.
-
addFolderImageLink
public void addFolderImageLink(FolderImageLink link, boolean bothSides)
Adds a ome.model.containers.FolderImageLink to imageLinks, allowing for recursion -- whether or not addFolderImageLink will be called on the addition if it is loaded
-
linkedImageIterator
public java.util.Iterator<Image> linkedImageIterator()
provides an iterator over the parent values of the imageLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in anConcurrentModificationException. UselinkedImageList()instead.
-
findFolderImageLink
public java.util.Set<FolderImageLink> findFolderImageLink(Image target)
find all ome.model.containers.FolderImageLink which have the argument as their child.
-
linkedImageList
public java.util.List<Image> linkedImageList()
produces aList-copy of the underlying collection. Unlike,linkedImageIterator(), while using the returnedList, modifications can be made to the underlying collection without throwingConcurrentModificationException.
-
eachLinkedImage
public <E> java.util.List<E> eachLinkedImage(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.core.Image while collecting the results. Ifblock == null, then the iterator values themselves are collected.
-
unlinkImage
public void unlinkImage(Image removal)
unlinks all ome.model.core.Image instances from this instance.
-
removeFolderImageLink
public void removeFolderImageLink(FolderImageLink link, boolean bothSides)
removes the given FolderImageLink from imageLinks, allowing for recursion -- whether or not the removal will call unlinkFolder again if loaded.
-
clearImageLinks
public void clearImageLinks()
clears the set.
-
setImageLinksCountPerOwner
protected void setImageLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
-
getImageLinksCountPerOwner
public java.util.Map<java.lang.Long,java.lang.Long> getImageLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.containers.FolderImageLink that a user has. If unfetched, returns null. No entries in the collection should be null.
-
getRoiLinks
protected java.util.Set<FolderRoiLink> getRoiLinks()
returns roiLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.containers.Folder.roiLinks (ome.model.containers.FolderRoiLink)
-
setRoiLinks
protected void setRoiLinks(java.util.Set<FolderRoiLink> roiLinks)
setter for roiLinks should be avoided. Does not fulfill normal semantics.
-
sizeOfRoiLinks
public int sizeOfRoiLinks()
returns the size of roiLinks. If less than zero, the Set was null.
-
iterateRoiLinks
public java.util.Iterator<FolderRoiLink> iterateRoiLinks()
should be used rather than accessing the roiLinks set directly. This method will never return null, but rather will return an instance ofEmptyIterator. To test for a null collection, see ofsizeOfRoiLinks()is less than zero.
-
unmodifiableRoiLinks
public java.util.Collection<FolderRoiLink> unmodifiableRoiLinks()
Returns an unmodifiable collection-view
-
collectRoiLinks
public <E> java.util.List<E> collectRoiLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.containers.FolderRoiLink while collecting the results. Ifblock == null, then the iterator values themselves are collected. This method usesiterateRoiLinks()internally and so will return a value even if the underlying collection is null.
-
addFolderRoiLink
public void addFolderRoiLink(FolderRoiLink target)
use instead of setRoiLinks . Makes the necessary call on ome.model.containers.FolderRoiLink as well.
-
addFolderRoiLinkSet
public void addFolderRoiLinkSet(java.util.Collection<FolderRoiLink> targets)
use like addFolderRoiLink.
-
removeFolderRoiLink
public void removeFolderRoiLink(FolderRoiLink target)
removes a single element from this set and makes the inverse call on ome.model.containers.FolderRoiLink
-
removeFolderRoiLinkSet
public void removeFolderRoiLinkSet(java.util.Collection<FolderRoiLink> targets)
use like removeFolderRoiLink
-
linkRoi
public FolderRoiLink linkRoi(Roi addition)
Adds a ome.model.containers.FolderRoiLink to roiLinks . This entails changing our roiLinks Set, creating a new ome.model.containers.FolderRoiLink and calling linkRoi on the ome.model.roi.Roi.
-
addFolderRoiLink
public void addFolderRoiLink(FolderRoiLink link, boolean bothSides)
Adds a ome.model.containers.FolderRoiLink to roiLinks, allowing for recursion -- whether or not addFolderRoiLink will be called on the addition if it is loaded
-
linkedRoiIterator
public java.util.Iterator<Roi> linkedRoiIterator()
provides an iterator over the parent values of the roiLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in anConcurrentModificationException. UselinkedRoiList()instead.
-
findFolderRoiLink
public java.util.Set<FolderRoiLink> findFolderRoiLink(Roi target)
find all ome.model.containers.FolderRoiLink which have the argument as their child.
-
linkedRoiList
public java.util.List<Roi> linkedRoiList()
produces aList-copy of the underlying collection. Unlike,linkedRoiIterator(), while using the returnedList, modifications can be made to the underlying collection without throwingConcurrentModificationException.
-
eachLinkedRoi
public <E> java.util.List<E> eachLinkedRoi(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.roi.Roi while collecting the results. Ifblock == null, then the iterator values themselves are collected.
-
unlinkRoi
public void unlinkRoi(Roi removal)
unlinks all ome.model.roi.Roi instances from this instance.
-
removeFolderRoiLink
public void removeFolderRoiLink(FolderRoiLink link, boolean bothSides)
removes the given FolderRoiLink from roiLinks, allowing for recursion -- whether or not the removal will call unlinkFolder again if loaded.
-
clearRoiLinks
public void clearRoiLinks()
clears the set.
-
setRoiLinksCountPerOwner
protected void setRoiLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
-
getRoiLinksCountPerOwner
public java.util.Map<java.lang.Long,java.lang.Long> getRoiLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.containers.FolderRoiLink that a user has. If unfetched, returns null. No entries in the collection should be null.
-
getAnnotationLinks
protected java.util.Set<FolderAnnotationLink> 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.containers.Folder.annotationLinks (ome.model.annotations.FolderAnnotationLink)
-
setAnnotationLinks
protected void setAnnotationLinks(java.util.Set<FolderAnnotationLink> 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:
sizeOfAnnotationLinksin interfaceIAnnotated
-
iterateAnnotationLinks
public java.util.Iterator<FolderAnnotationLink> iterateAnnotationLinks()
should be used rather than accessing the annotationLinks set directly. This method will never return null, but rather will return an instance ofEmptyIterator. To test for a null collection, see ofsizeOfAnnotationLinks()is less than zero.- Specified by:
iterateAnnotationLinksin interfaceIAnnotated
-
unmodifiableAnnotationLinks
public java.util.Collection<FolderAnnotationLink> unmodifiableAnnotationLinks()
Returns an unmodifiable collection-view- Specified by:
unmodifiableAnnotationLinksin interfaceIAnnotated
-
collectAnnotationLinks
public <E> java.util.List<E> collectAnnotationLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.annotations.FolderAnnotationLink while collecting the results. Ifblock == null, then the iterator values themselves are collected. This method usesiterateAnnotationLinks()internally and so will return a value even if the underlying collection is null.- Specified by:
collectAnnotationLinksin interfaceIAnnotated
-
addFolderAnnotationLink
public void addFolderAnnotationLink(FolderAnnotationLink target)
use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.FolderAnnotationLink as well.
-
addFolderAnnotationLinkSet
public void addFolderAnnotationLinkSet(java.util.Collection<FolderAnnotationLink> targets)
use like addFolderAnnotationLink.
-
removeFolderAnnotationLink
public void removeFolderAnnotationLink(FolderAnnotationLink target)
removes a single element from this set and makes the inverse call on ome.model.annotations.FolderAnnotationLink
-
removeFolderAnnotationLinkSet
public void removeFolderAnnotationLinkSet(java.util.Collection<FolderAnnotationLink> targets)
use like removeFolderAnnotationLink
-
linkAnnotation
public FolderAnnotationLink linkAnnotation(Annotation addition)
Adds a ome.model.annotations.FolderAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.FolderAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.- Specified by:
linkAnnotationin interfaceIAnnotated
-
addFolderAnnotationLink
public void addFolderAnnotationLink(FolderAnnotationLink link, boolean bothSides)
Adds a ome.model.annotations.FolderAnnotationLink to annotationLinks, allowing for recursion -- whether or not addFolderAnnotationLink 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 anConcurrentModificationException. UselinkedAnnotationList()instead.- Specified by:
linkedAnnotationIteratorin interfaceIAnnotated
-
findFolderAnnotationLink
public java.util.Set<FolderAnnotationLink> findFolderAnnotationLink(Annotation target)
find all ome.model.annotations.FolderAnnotationLink which have the argument as their child.
-
linkedAnnotationList
public java.util.List<Annotation> linkedAnnotationList()
produces aList-copy of the underlying collection. Unlike,linkedAnnotationIterator(), while using the returnedList, modifications can be made to the underlying collection without throwingConcurrentModificationException.- Specified by:
linkedAnnotationListin interfaceIAnnotated
-
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. Ifblock == null, then the iterator values themselves are collected.- Specified by:
eachLinkedAnnotationin interfaceIAnnotated
-
unlinkAnnotation
public void unlinkAnnotation(Annotation removal)
unlinks all ome.model.annotations.Annotation instances from this instance.- Specified by:
unlinkAnnotationin interfaceIAnnotated
-
removeFolderAnnotationLink
public void removeFolderAnnotationLink(FolderAnnotationLink link, boolean bothSides)
removes the given FolderAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkFolder again if loaded.
-
clearAnnotationLinks
public void clearAnnotationLinks()
clears the set.- Specified by:
clearAnnotationLinksin interfaceIAnnotated
-
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.FolderAnnotationLink that a user has. If unfetched, returns null. No entries in the collection should be null.
-
getName
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields") public java.lang.String getName()
Simple field ome.model.containers.Folder.name (java.lang.String)
-
setName
public void setName(java.lang.String name)
-
getDescription
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields") public java.lang.String getDescription()
Simple field ome.model.containers.Folder.description (java.lang.String)
-
setDescription
public void setDescription(java.lang.String description)
-
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 theDetailstype.- Specified by:
getDetailsin interfaceIObject
-
setDetails
protected void setDetails(Details details)
-
isValid
public boolean isValid()
Description copied from interface:IObjectcalls the class-specific validator for this instance and returns the value fromValidation.isValid()
-
validate
public Validation validate()
Description copied from interface:IObjectcalls the class-specific validator for this instance and returns theValidationobject.
-
newInstance
public Folder newInstance()
-
proxy
public Folder proxy()
-
acceptFilter
public boolean acceptFilter(Filter __filter)
- Specified by:
acceptFilterin interfaceFilterable
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
fields
public java.util.Set<java.lang.String> fields()
Description copied from interface:IObjectreturns a Set of field names that belong to this class
-
retrieve
public java.lang.Object retrieve(java.lang.String field)
Description copied from interface:IObjectretrieves a value from this instance. Values forfieldwhich match a field of this instance will be delegated to the accessors. Otherwise, values will be retrieved from a lazy-loaded map filled by calls toIObject.putAt(String, Object)
-
putAt
public void putAt(java.lang.String field, java.lang.Object value)Description copied from interface:IObjectstores a value in this instance. Values forfieldwhich match a field of this instance will be delegated to the accessors. Otherwise, values will be stored in a lazy-loaded map.
-
isLoaded
public boolean isLoaded()
Description copied from interface:IObjecttransient field (not stored in the DB) which specifies whether this object has been loaded from the DB or is only a wrapper around the ID.
-
errorIfUnloaded
protected void errorIfUnloaded()
-
unload
public void unload()
Description copied from interface:IObjectset the loaded field to false, and set all non-ID fields to null. Subsequent calls to all accessors other than getId/setId will throw an ApiUsageException
-
getGraphHolder
public final GraphHolder getGraphHolder()
Description copied from interface:IObjectretrieves theGraphHolderfor this entity. If the GraphHolder has not been actively set, a new one will be instatiated.- Specified by:
getGraphHolderin interfaceIObject- Returns:
- Non-null GraphHolder
-
throwNullCollectionException
protected void throwNullCollectionException(java.lang.String propertyName)
-
-