Folder (OMERO API)

java.lang.Object
- ome.model.containers.Folder

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

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`_dynamicFields`
`protected boolean`	`_loaded`
`protected Set<FolderAnnotationLink>`	`annotationLinks`
`static String`	`ANNOTATIONLINKS`
`static String`	`ANNOTATIONLINKSCOUNTPEROWNER`
`protected Set<Folder>`	`childFolders`
`static String`	`CHILDFOLDERS`
`protected String`	`description`
`static String`	`DESCRIPTION`
`protected Details`	`details`
`static String`	`DETAILS`
`static String`	`EVENT_FILTER`
`static String`	`EVENT_FILTER_ANNOTATIONLINKS`
`static String`	`EVENT_FILTER_CHILDFOLDERS`
`static String`	`EVENT_FILTER_IMAGELINKS`
`static String`	`EVENT_FILTER_ROILINKS`
`static Set<String>`	`FIELDS`
`static String`	`GROUP_FILTER`
`static String`	`GROUP_FILTER_ANNOTATIONLINKS`
`static String`	`GROUP_FILTER_CHILDFOLDERS`
`static String`	`GROUP_FILTER_IMAGELINKS`
`static String`	`GROUP_FILTER_ROILINKS`
`protected Long`	`id`
`static String`	`ID`
`protected Set<FolderImageLink>`	`imageLinks`
`static String`	`IMAGELINKS`
`static String`	`IMAGELINKSCOUNTPEROWNER`
`protected String`	`name`
`static String`	`NAME`
`static String`	`OWNER_FILTER`
`static String`	`OWNER_FILTER_ANNOTATIONLINKS`
`static String`	`OWNER_FILTER_CHILDFOLDERS`
`static String`	`OWNER_FILTER_IMAGELINKS`
`static String`	`OWNER_FILTER_ROILINKS`
`protected Folder`	`parentFolder`
`static String`	`PARENTFOLDER`
`static String`	`PERMS_FILTER`
`static String`	`PERMS_FILTER_ANNOTATIONLINKS`
`static String`	`PERMS_FILTER_CHILDFOLDERS`
`static String`	`PERMS_FILTER_IMAGELINKS`
`static String`	`PERMS_FILTER_ROILINKS`
`protected Set<FolderRoiLink>`	`roiLinks`
`static String`	`ROILINKS`
`static String`	`ROILINKSCOUNTPEROWNER`
`protected Integer`	`version`
`static String`	`VERSION`

Constructor Summary

Constructors
Modifier Constructor and Description

Folder()

protected Folder(Long id)

Folder(Long id, boolean loaded)
Main constructor.

Folder(String _name)

Constructors
Modifier	Constructor and Description
	`Folder()`
`protected`	`Folder(Long id)`
	`Folder(Long id, boolean loaded)` Main constructor.
	`Folder(String _name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter __filter)`
`void`	`addChildFolders(Folder target)` use instead of setChildFolders .
`void`	`addChildFoldersSet(Collection<Folder> targets)` use like addFolder.
`void`	`addFolderAnnotationLink(FolderAnnotationLink target)` use instead of setAnnotationLinks .
`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
`void`	`addFolderAnnotationLinkSet(Collection<FolderAnnotationLink> targets)` use like addFolderAnnotationLink.
`void`	`addFolderImageLink(FolderImageLink target)` use instead of setImageLinks .
`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
`void`	`addFolderImageLinkSet(Collection<FolderImageLink> targets)` use like addFolderImageLink.
`void`	`addFolderRoiLink(FolderRoiLink target)` use instead of setRoiLinks .
`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
`void`	`addFolderRoiLinkSet(Collection<FolderRoiLink> targets)` use like addFolderRoiLink.
`void`	`clearAnnotationLinks()` clears the set.
`void`	`clearChildFolders()` clears the set.
`void`	`clearImageLinks()` clears the set.
`void`	`clearRoiLinks()` clears the set.
`<E> 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> 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> 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> 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> 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>`	`eachLinkedImage(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.core.Image while collecting the results.
`<E> 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 void`	`errorIfUnloaded()`
`Set<String>`	`fields()` returns a Set of field names that belong to this class
`Set<FolderAnnotationLink>`	`findFolderAnnotationLink(Annotation target)` find all ome.model.annotations.FolderAnnotationLink which have the argument as their child.
`Set<FolderImageLink>`	`findFolderImageLink(Image target)` find all ome.model.containers.FolderImageLink which have the argument as their child.
`Set<FolderRoiLink>`	`findFolderRoiLink(Roi target)` find all ome.model.containers.FolderRoiLink which have the argument as their child.
`protected Set<FolderAnnotationLink>`	`getAnnotationLinks()` returns annotationLinks .
`Map<Long,Long>`	`getAnnotationLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.annotations.FolderAnnotationLink that a user has.
`protected Set<Folder>`	`getChildFolders()` returns childFolders .
`String`	`getDescription()` Simple field ome.model.containers.Folder.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.
`protected Set<FolderImageLink>`	`getImageLinks()` returns imageLinks .
`Map<Long,Long>`	`getImageLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.containers.FolderImageLink that a user has.
`String`	`getName()` Simple field ome.model.containers.Folder.name (java.lang.String)
`Folder`	`getParentFolder()` Many-to-one field ome.model.containers.Folder.parentFolder (ome.model.containers.Folder)
`protected Set<FolderRoiLink>`	`getRoiLinks()` returns roiLinks .
`Map<Long,Long>`	`getRoiLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.containers.FolderRoiLink that a user has.
`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<FolderAnnotationLink>`	`iterateAnnotationLinks()` should be used rather than accessing the annotationLinks set directly.
`Iterator<Folder>`	`iterateChildFolders()` should be used rather than accessing the childFolders set directly.
`Iterator<FolderImageLink>`	`iterateImageLinks()` should be used rather than accessing the imageLinks set directly.
`Iterator<FolderRoiLink>`	`iterateRoiLinks()` should be used rather than accessing the roiLinks set directly.
`FolderAnnotationLink`	`linkAnnotation(Annotation addition)` Adds a ome.model.annotations.FolderAnnotationLink 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<Image>`	`linkedImageIterator()` provides an iterator over the parent values of the imageLinks.
`List<Image>`	`linkedImageList()` produces a `List`-copy of the underlying collection.
`Iterator<Roi>`	`linkedRoiIterator()` provides an iterator over the parent values of the roiLinks.
`List<Roi>`	`linkedRoiList()` produces a `List`-copy of the underlying collection.
`FolderImageLink`	`linkImage(Image addition)` Adds a ome.model.containers.FolderImageLink to imageLinks .
`FolderRoiLink`	`linkRoi(Roi addition)` Adds a ome.model.containers.FolderRoiLink to roiLinks .
`Folder`	`newInstance()`
`Folder`	`proxy()`
`void`	`putAt(String field, Object value)` stores a value in this instance.
`void`	`removeChildFolders(Folder target)` removes a single element from this set and makes the inverse call on ome.model.containers.Folder
`void`	`removeChildFoldersSet(Collection<Folder> targets)` use like removeFolder
`void`	`removeFolderAnnotationLink(FolderAnnotationLink target)` removes a single element from this set and makes the inverse call on ome.model.annotations.FolderAnnotationLink
`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.
`void`	`removeFolderAnnotationLinkSet(Collection<FolderAnnotationLink> targets)` use like removeFolderAnnotationLink
`void`	`removeFolderImageLink(FolderImageLink target)` removes a single element from this set and makes the inverse call on ome.model.containers.FolderImageLink
`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.
`void`	`removeFolderImageLinkSet(Collection<FolderImageLink> targets)` use like removeFolderImageLink
`void`	`removeFolderRoiLink(FolderRoiLink target)` removes a single element from this set and makes the inverse call on ome.model.containers.FolderRoiLink
`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.
`void`	`removeFolderRoiLinkSet(Collection<FolderRoiLink> targets)` use like removeFolderRoiLink
`Object`	`retrieve(String field)` retrieves a value from this instance.
`protected void`	`setAnnotationLinks(Set<FolderAnnotationLink> annotationLinks)` setter for annotationLinks should be avoided.
`protected void`	`setAnnotationLinksCountPerOwner(Map<Long,Long> map)`
`protected void`	`setChildFolders(Set<Folder> childFolders)` setter for childFolders should be avoided.
`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 `Folder.Details` instance instead.
`void`	`setId(Long id)` usually unneeded.
`protected void`	`setImageLinks(Set<FolderImageLink> imageLinks)` setter for imageLinks should be avoided.
`protected void`	`setImageLinksCountPerOwner(Map<Long,Long> map)`
`void`	`setName(String name)`
`void`	`setParentFolder(Folder parentFolder)`
`protected void`	`setRoiLinks(Set<FolderRoiLink> roiLinks)` setter for roiLinks should be avoided.
`protected void`	`setRoiLinksCountPerOwner(Map<Long,Long> map)`
`void`	`setVersion(Integer version)` use with caution.
`int`	`sizeOfAnnotationLinks()` returns the size of annotationLinks.
`int`	`sizeOfChildFolders()` returns the size of childFolders.
`int`	`sizeOfImageLinks()` returns the size of imageLinks.
`int`	`sizeOfRoiLinks()` returns the size of roiLinks.
`protected void`	`throwNullCollectionException(String propertyName)`
`String`	`toString()`
`void`	`unlinkAnnotation(Annotation removal)` unlinks all ome.model.annotations.Annotation instances from this instance.
`void`	`unlinkImage(Image removal)` unlinks all ome.model.core.Image instances from this instance.
`void`	`unlinkRoi(Roi removal)` unlinks all ome.model.roi.Roi instances from this instance.
`void`	`unload()` set the loaded field to false, and set all non-ID fields to null.
`Collection<FolderAnnotationLink>`	`unmodifiableAnnotationLinks()` Returns an unmodifiable collection-view
`Collection<Folder>`	`unmodifiableChildFolders()` Returns an unmodifiable collection-view
`Collection<FolderImageLink>`	`unmodifiableImageLinks()` Returns an unmodifiable collection-view
`Collection<FolderRoiLink>`	`unmodifiableRoiLinks()` 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
```
  - childFolders
```
protected Set<Folder> childFolders
```
  - OWNER_FILTER_CHILDFOLDERS
```
public static final String OWNER_FILTER_CHILDFOLDERS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_CHILDFOLDERS
```
public static final String GROUP_FILTER_CHILDFOLDERS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_CHILDFOLDERS
```
public static final String EVENT_FILTER_CHILDFOLDERS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_CHILDFOLDERS
```
public static final String PERMS_FILTER_CHILDFOLDERS
```
    See Also:
    
    Constant Field Values
  - parentFolder
```
protected Folder parentFolder
```
  - imageLinks
```
protected Set<FolderImageLink> imageLinks
```
  - OWNER_FILTER_IMAGELINKS
```
public static final String OWNER_FILTER_IMAGELINKS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_IMAGELINKS
```
public static final String GROUP_FILTER_IMAGELINKS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_IMAGELINKS
```
public static final String EVENT_FILTER_IMAGELINKS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_IMAGELINKS
```
public static final String PERMS_FILTER_IMAGELINKS
```
    See Also:
    
    Constant Field Values
  - roiLinks
```
protected Set<FolderRoiLink> roiLinks
```
  - OWNER_FILTER_ROILINKS
```
public static final String OWNER_FILTER_ROILINKS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_ROILINKS
```
public static final String GROUP_FILTER_ROILINKS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_ROILINKS
```
public static final String EVENT_FILTER_ROILINKS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_ROILINKS
```
public static final String PERMS_FILTER_ROILINKS
```
    See Also:
    
    Constant Field Values
  - annotationLinks
```
protected Set<FolderAnnotationLink> 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
  - name
```
protected String name
```
  - description
```
protected String description
```
  - details
```
protected Details details
```
  - CHILDFOLDERS
```
public static final String CHILDFOLDERS
```
    See Also:
    
    Constant Field Values
  - PARENTFOLDER
```
public static final String PARENTFOLDER
```
    See Also:
    
    Constant Field Values
  - IMAGELINKSCOUNTPEROWNER
```
public static final String IMAGELINKSCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - IMAGELINKS
```
public static final String IMAGELINKS
```
    See Also:
    
    Constant Field Values
  - ROILINKSCOUNTPEROWNER
```
public static final String ROILINKSCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - ROILINKS
```
public static final String ROILINKS
```
    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
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final String DESCRIPTION
```
    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
  - Folder
```
public Folder()
```
  - Folder
```
protected Folder(Long id)
```
  - Folder
```
public Folder(Long id,
              boolean loaded)
```
    Main constructor.
  - Folder
```
public Folder(String _name)
```
- 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.
  - getChildFolders
```
protected 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(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 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 of EmptyIterator. To test for a null collection, see of sizeOfChildFolders() is less than zero.
  - unmodifiableChildFolders
```
public Collection<Folder> unmodifiableChildFolders()
```
    Returns an unmodifiable collection-view
  - collectChildFolders
```
public <E> List<E> collectChildFolders(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.containers.Folder while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateChildFolders() 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(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(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 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(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 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 of EmptyIterator. To test for a null collection, see of sizeOfImageLinks() is less than zero.
  - unmodifiableImageLinks
```
public Collection<FolderImageLink> unmodifiableImageLinks()
```
    Returns an unmodifiable collection-view
  - collectImageLinks
```
public <E> List<E> collectImageLinks(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.containers.FolderImageLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateImageLinks() 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(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(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 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 an ConcurrentModificationException. Use linkedImageList() instead.
  - findFolderImageLink
```
public Set<FolderImageLink> findFolderImageLink(Image target)
```
    find all ome.model.containers.FolderImageLink which have the argument as their child.
  - linkedImageList
```
public List<Image> linkedImageList()
```
    produces a List-copy of the underlying collection. Unlike, linkedImageIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
  - eachLinkedImage
```
public <E> List<E> eachLinkedImage(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.core.Image while collecting the results. If block == 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(Map<Long,Long> map)
```
  - getImageLinksCountPerOwner
```
public Map<Long,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 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(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 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 of EmptyIterator. To test for a null collection, see of sizeOfRoiLinks() is less than zero.
  - unmodifiableRoiLinks
```
public Collection<FolderRoiLink> unmodifiableRoiLinks()
```
    Returns an unmodifiable collection-view
  - collectRoiLinks
```
public <E> List<E> collectRoiLinks(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.containers.FolderRoiLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateRoiLinks() 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(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(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 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 an ConcurrentModificationException. Use linkedRoiList() instead.
  - findFolderRoiLink
```
public Set<FolderRoiLink> findFolderRoiLink(Roi target)
```
    find all ome.model.containers.FolderRoiLink which have the argument as their child.
  - linkedRoiList
```
public List<Roi> linkedRoiList()
```
    produces a List-copy of the underlying collection. Unlike, linkedRoiIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
  - eachLinkedRoi
```
public <E> List<E> eachLinkedRoi(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.roi.Roi while collecting the results. If block == 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(Map<Long,Long> map)
```
  - getRoiLinksCountPerOwner
```
public Map<Long,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 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(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:
    
    sizeOfAnnotationLinks in interface IAnnotated
  - iterateAnnotationLinks
```
public 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 of EmptyIterator. To test for a null collection, see of sizeOfAnnotationLinks() is less than zero.
    
    Specified by:
    
    iterateAnnotationLinks in interface IAnnotated
  - unmodifiableAnnotationLinks
```
public Collection<FolderAnnotationLink> 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.FolderAnnotationLink 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
  - 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(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(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:
    
    linkAnnotation in interface IAnnotated
  - 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 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
  - findFolderAnnotationLink
```
public Set<FolderAnnotationLink> findFolderAnnotationLink(Annotation target)
```
    find all ome.model.annotations.FolderAnnotationLink 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
  - 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:
    
    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.FolderAnnotationLink that a user has. If unfetched, returns null. No entries in the collection should be null.
  - getName
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getName()
```
    Simple field ome.model.containers.Folder.name (java.lang.String)
  - setName
```
public void setName(String name)
```
  - getDescription
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getDescription()
```
    Simple field ome.model.containers.Folder.description (java.lang.String)
  - setDescription
```
public void setDescription(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 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 Folder.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 Folder newInstance()
```
  - proxy
```
public Folder 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 Folder

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

childFolders

OWNER_FILTER_CHILDFOLDERS

GROUP_FILTER_CHILDFOLDERS

EVENT_FILTER_CHILDFOLDERS

PERMS_FILTER_CHILDFOLDERS

parentFolder

imageLinks

OWNER_FILTER_IMAGELINKS

GROUP_FILTER_IMAGELINKS

EVENT_FILTER_IMAGELINKS

PERMS_FILTER_IMAGELINKS

roiLinks

OWNER_FILTER_ROILINKS

GROUP_FILTER_ROILINKS

EVENT_FILTER_ROILINKS

PERMS_FILTER_ROILINKS

annotationLinks

OWNER_FILTER_ANNOTATIONLINKS

GROUP_FILTER_ANNOTATIONLINKS

EVENT_FILTER_ANNOTATIONLINKS

PERMS_FILTER_ANNOTATIONLINKS

name

description

details

CHILDFOLDERS

PARENTFOLDER

IMAGELINKSCOUNTPEROWNER

IMAGELINKS

ROILINKSCOUNTPEROWNER

ROILINKS

ANNOTATIONLINKSCOUNTPEROWNER

ANNOTATIONLINKS

NAME

DESCRIPTION

DETAILS

FIELDS

_dynamicFields

_loaded

Constructor Detail

Folder

Folder

Folder

Folder

Method Detail

getId

setId

getVersion

setVersion

getChildFolders

setChildFolders

sizeOfChildFolders

iterateChildFolders

unmodifiableChildFolders

collectChildFolders

addChildFolders

addChildFoldersSet

removeChildFolders

removeChildFoldersSet

clearChildFolders

getParentFolder

setParentFolder

getImageLinks

setImageLinks

sizeOfImageLinks

iterateImageLinks