Package ome.model.fs
Class Fileset
- java.lang.Object
-
- ome.model.fs.Fileset
-
- 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 Fileset extends java.lang.Object implements java.io.Serializable, IObject, IMutable, IAnnotated
These filter definitions are used by the security system to eliminate non-readable objects from queries. The regular user does not need to worry about them, as they will be injected directly into the SQL (not HQL)- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Fileset.Details
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<java.lang.String,java.lang.Object>
_dynamicFields
protected boolean
_loaded
protected java.util.Set<FilesetAnnotationLink>
annotationLinks
static java.lang.String
ANNOTATIONLINKS
static java.lang.String
ANNOTATIONLINKSCOUNTPEROWNER
protected Details
details
static java.lang.String
DETAILS
static java.lang.String
EVENT_FILTER
static java.lang.String
EVENT_FILTER_ANNOTATIONLINKS
static java.lang.String
EVENT_FILTER_IMAGES
static java.lang.String
EVENT_FILTER_JOBLINKS
static java.lang.String
EVENT_FILTER_USEDFILES
static java.util.Set<java.lang.String>
FIELDS
static java.lang.String
GROUP_FILTER
static java.lang.String
GROUP_FILTER_ANNOTATIONLINKS
static java.lang.String
GROUP_FILTER_IMAGES
static java.lang.String
GROUP_FILTER_JOBLINKS
static java.lang.String
GROUP_FILTER_USEDFILES
protected java.lang.Long
id
static java.lang.String
ID
protected java.util.Set<Image>
images
static java.lang.String
IMAGES
protected java.util.List<FilesetJobLink>
jobLinks
static java.lang.String
JOBLINKS
static java.lang.String
JOBLINKSCOUNTPEROWNER
static java.lang.String
OWNER_FILTER
static java.lang.String
OWNER_FILTER_ANNOTATIONLINKS
static java.lang.String
OWNER_FILTER_IMAGES
static java.lang.String
OWNER_FILTER_JOBLINKS
static java.lang.String
OWNER_FILTER_USEDFILES
static java.lang.String
PERMS_FILTER
static java.lang.String
PERMS_FILTER_ANNOTATIONLINKS
static java.lang.String
PERMS_FILTER_IMAGES
static java.lang.String
PERMS_FILTER_JOBLINKS
static java.lang.String
PERMS_FILTER_USEDFILES
protected java.lang.String
templatePrefix
static java.lang.String
TEMPLATEPREFIX
protected java.util.List<FilesetEntry>
usedFiles
static java.lang.String
USEDFILES
protected java.lang.Integer
version
static java.lang.String
VERSION
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
acceptFilter(Filter __filter)
void
addFilesetAnnotationLink(FilesetAnnotationLink target)
use instead of setAnnotationLinks .void
addFilesetAnnotationLink(FilesetAnnotationLink link, boolean bothSides)
Adds a ome.model.annotations.FilesetAnnotationLink to annotationLinks, allowing for recursion -- whether or not addFilesetAnnotationLink will be called on the addition if it is loadedvoid
addFilesetAnnotationLinkSet(java.util.Collection<FilesetAnnotationLink> targets)
use like addFilesetAnnotationLink.void
addFilesetEntry(FilesetEntry target)
use instead of setUsedFiles .void
addFilesetEntrySet(java.util.Collection<FilesetEntry> targets)
use like addFilesetEntry.void
addFilesetJobLink(FilesetJobLink target)
use instead of setJobLinks .void
addFilesetJobLink(FilesetJobLink link, boolean bothSides)
Adds a ome.model.fs.FilesetJobLink to jobLinks, allowing for recursion -- whether or not addFilesetJobLink will be called on the addition if it is loadedvoid
addFilesetJobLinkSet(java.util.Collection<FilesetJobLink> targets)
use like addFilesetJobLink.void
addImage(Image target)
use instead of setImages .void
addImageSet(java.util.Collection<Image> targets)
use like addImage.void
clearAnnotationLinks()
clears the set.void
clearImages()
clears the set.void
clearJobLinks()
clears the set.void
clearUsedFiles()
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.FilesetAnnotationLink while collecting the results.<E> java.util.List<E>
collectImages(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>
collectJobLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.fs.FilesetJobLink while collecting the results.<E> java.util.List<E>
collectUsedFiles(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.fs.FilesetEntry 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>
eachLinkedJob(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.jobs.Job while collecting the results.protected void
errorIfUnloaded()
java.util.Set<java.lang.String>
fields()
returns a Set of field names that belong to this classjava.util.Set<FilesetAnnotationLink>
findFilesetAnnotationLink(Annotation target)
find all ome.model.annotations.FilesetAnnotationLink which have the argument as their child.java.util.Set<FilesetJobLink>
findFilesetJobLink(Job target)
find all ome.model.fs.FilesetJobLink which have the argument as their child.protected java.util.Set<FilesetAnnotationLink>
getAnnotationLinks()
returns annotationLinks .java.util.Map<java.lang.Long,java.lang.Long>
getAnnotationLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.annotations.FilesetAnnotationLink that a user has.Details
getDetails()
The details of this object correspond to low-level system information.FilesetEntry
getFilesetEntry(int index)
Gets the ome.model.fs.FilesetEntry at the given index.FilesetJobLink
getFilesetJobLink(int index)
Gets the ome.model.fs.FilesetJobLink at the given index.GraphHolder
getGraphHolder()
retrieves theGraphHolder
for this entity.java.lang.Long
getId()
The DB unique identifier for this object.protected java.util.Set<Image>
getImages()
returns images .protected java.util.List<FilesetJobLink>
getJobLinks()
returns jobLinks .java.util.Map<java.lang.Long,java.lang.Long>
getJobLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.fs.FilesetJobLink that a user has.FilesetEntry
getPrimaryFilesetEntry()
Gets the first element of usedFiles which can be interpreted as the primary or default element in some situations.FilesetJobLink
getPrimaryFilesetJobLink()
Gets the first element of jobLinks which can be interpreted as the primary or default element in some situations.java.lang.String
getTemplatePrefix()
Simple field ome.model.fs.Fileset.templatePrefix (java.lang.String)protected java.util.List<FilesetEntry>
getUsedFiles()
returns usedFiles .java.lang.Integer
getVersion()
This version number is controlled by the database for optimisitic locking.boolean
isLoaded()
transient field (not stored in the DB) which specifies whether this object has been loaded from the DB or is only a wrapper around the ID.boolean
isValid()
calls the class-specific validator for this instance and returns the value fromValidation.isValid()
java.util.Iterator<FilesetAnnotationLink>
iterateAnnotationLinks()
should be used rather than accessing the annotationLinks set directly.java.util.Iterator<Image>
iterateImages()
should be used rather than accessing the images set directly.java.util.Iterator<FilesetJobLink>
iterateJobLinks()
should be used rather than accessing the jobLinks set directly.java.util.Iterator<FilesetEntry>
iterateUsedFiles()
should be used rather than accessing the usedFiles set directly.FilesetAnnotationLink
linkAnnotation(Annotation addition)
Adds a ome.model.annotations.FilesetAnnotationLink 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<Job>
linkedJobIterator()
provides an iterator over the parent values of the jobLinks.java.util.List<Job>
linkedJobList()
produces aList
-copy of the underlying collection.FilesetJobLink
linkJob(Job addition)
Adds a ome.model.fs.FilesetJobLink to jobLinks .Fileset
newInstance()
Fileset
proxy()
void
putAt(java.lang.String field, java.lang.Object value)
stores a value in this instance.void
removeFilesetAnnotationLink(FilesetAnnotationLink target)
removes a single element from this set and makes the inverse call on ome.model.annotations.FilesetAnnotationLinkvoid
removeFilesetAnnotationLink(FilesetAnnotationLink link, boolean bothSides)
removes the given FilesetAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkFileset again if loaded.void
removeFilesetAnnotationLinkSet(java.util.Collection<FilesetAnnotationLink> targets)
use like removeFilesetAnnotationLinkvoid
removeFilesetEntry(FilesetEntry target)
removes a single element from this set and makes the inverse call on ome.model.fs.FilesetEntryvoid
removeFilesetEntrySet(java.util.Collection<FilesetEntry> targets)
use like removeFilesetEntryvoid
removeFilesetJobLink(FilesetJobLink target)
removes a single element from this set and makes the inverse call on ome.model.fs.FilesetJobLinkvoid
removeFilesetJobLink(FilesetJobLink link, boolean bothSides)
removes the given FilesetJobLink from jobLinks, allowing for recursion -- whether or not the removal will call unlinkFileset again if loaded.void
removeFilesetJobLinkSet(java.util.Collection<FilesetJobLink> targets)
use like removeFilesetJobLinkvoid
removeImage(Image target)
removes a single element from this set and makes the inverse call on ome.model.core.Imagevoid
removeImageSet(java.util.Collection<Image> targets)
use like removeImagejava.lang.Object
retrieve(java.lang.String field)
retrieves a value from this instance.protected void
setAnnotationLinks(java.util.Set<FilesetAnnotationLink> annotationLinks)
setter for annotationLinks should be avoided.protected void
setAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
protected void
setDetails(Details details)
FilesetEntry
setFilesetEntry(int index, FilesetEntry element)
Sets the ome.model.fs.FilesetEntry at the given index.FilesetJobLink
setFilesetJobLink(int index, FilesetJobLink element)
Sets the ome.model.fs.FilesetJobLink at the given index.void
setId(java.lang.Long id)
usually unneeded.protected void
setImages(java.util.Set<Image> images)
setter for images should be avoided.protected void
setJobLinks(java.util.List<FilesetJobLink> jobLinks)
setter for jobLinks should be avoided.protected void
setJobLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
FilesetEntry
setPrimaryFilesetEntry(FilesetEntry element)
Swaps the first element of usedFiles with the first instance of the given element.FilesetJobLink
setPrimaryFilesetJobLink(FilesetJobLink element)
Swaps the first element of jobLinks with the first instance of the given element.void
setTemplatePrefix(java.lang.String templatePrefix)
protected void
setUsedFiles(java.util.List<FilesetEntry> usedFiles)
setter for usedFiles should be avoided.void
setVersion(java.lang.Integer version)
use with caution.int
sizeOfAnnotationLinks()
returns the size of annotationLinks.int
sizeOfImages()
returns the size of images.int
sizeOfJobLinks()
returns the size of jobLinks.int
sizeOfUsedFiles()
returns the size of usedFiles.protected void
throwNullCollectionException(java.lang.String propertyName)
java.lang.String
toString()
void
unlinkAnnotation(Annotation removal)
unlinks all ome.model.annotations.Annotation instances from this instance.void
unlinkJob(Job removal)
unlinks all ome.model.jobs.Job instances from this instance.void
unload()
set the loaded field to false, and set all non-ID fields to null.java.util.Collection<FilesetAnnotationLink>
unmodifiableAnnotationLinks()
Returns an unmodifiable collection-viewjava.util.Collection<Image>
unmodifiableImages()
Returns an unmodifiable collection-viewjava.util.Collection<FilesetJobLink>
unmodifiableJobLinks()
Returns an unmodifiable collection-viewjava.util.Collection<FilesetEntry>
unmodifiableUsedFiles()
Returns an unmodifiable collection-viewValidation
validate()
calls the class-specific validator for this instance and returns theValidation
object.
-
-
-
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
-
usedFiles
protected java.util.List<FilesetEntry> usedFiles
-
OWNER_FILTER_USEDFILES
public static final java.lang.String OWNER_FILTER_USEDFILES
- See Also:
- Constant Field Values
-
GROUP_FILTER_USEDFILES
public static final java.lang.String GROUP_FILTER_USEDFILES
- See Also:
- Constant Field Values
-
EVENT_FILTER_USEDFILES
public static final java.lang.String EVENT_FILTER_USEDFILES
- See Also:
- Constant Field Values
-
PERMS_FILTER_USEDFILES
public static final java.lang.String PERMS_FILTER_USEDFILES
- See Also:
- Constant Field Values
-
images
protected java.util.Set<Image> images
-
OWNER_FILTER_IMAGES
public static final java.lang.String OWNER_FILTER_IMAGES
- See Also:
- Constant Field Values
-
GROUP_FILTER_IMAGES
public static final java.lang.String GROUP_FILTER_IMAGES
- See Also:
- Constant Field Values
-
EVENT_FILTER_IMAGES
public static final java.lang.String EVENT_FILTER_IMAGES
- See Also:
- Constant Field Values
-
PERMS_FILTER_IMAGES
public static final java.lang.String PERMS_FILTER_IMAGES
- See Also:
- Constant Field Values
-
jobLinks
protected java.util.List<FilesetJobLink> jobLinks
-
OWNER_FILTER_JOBLINKS
public static final java.lang.String OWNER_FILTER_JOBLINKS
- See Also:
- Constant Field Values
-
GROUP_FILTER_JOBLINKS
public static final java.lang.String GROUP_FILTER_JOBLINKS
- See Also:
- Constant Field Values
-
EVENT_FILTER_JOBLINKS
public static final java.lang.String EVENT_FILTER_JOBLINKS
- See Also:
- Constant Field Values
-
PERMS_FILTER_JOBLINKS
public static final java.lang.String PERMS_FILTER_JOBLINKS
- See Also:
- Constant Field Values
-
templatePrefix
protected java.lang.String templatePrefix
-
annotationLinks
protected java.util.Set<FilesetAnnotationLink> annotationLinks
-
OWNER_FILTER_ANNOTATIONLINKS
public static final java.lang.String OWNER_FILTER_ANNOTATIONLINKS
- See Also:
- Constant Field Values
-
GROUP_FILTER_ANNOTATIONLINKS
public static final java.lang.String GROUP_FILTER_ANNOTATIONLINKS
- See Also:
- Constant Field Values
-
EVENT_FILTER_ANNOTATIONLINKS
public static final java.lang.String EVENT_FILTER_ANNOTATIONLINKS
- See Also:
- Constant Field Values
-
PERMS_FILTER_ANNOTATIONLINKS
public static final java.lang.String PERMS_FILTER_ANNOTATIONLINKS
- See Also:
- Constant Field Values
-
details
protected Details details
-
USEDFILES
public static final java.lang.String USEDFILES
- See Also:
- Constant Field Values
-
IMAGES
public static final java.lang.String IMAGES
- See Also:
- Constant Field Values
-
JOBLINKSCOUNTPEROWNER
public static final java.lang.String JOBLINKSCOUNTPEROWNER
- See Also:
- Constant Field Values
-
JOBLINKS
public static final java.lang.String JOBLINKS
- See Also:
- Constant Field Values
-
TEMPLATEPREFIX
public static final java.lang.String TEMPLATEPREFIX
- See Also:
- Constant Field Values
-
ANNOTATIONLINKSCOUNTPEROWNER
public static final java.lang.String ANNOTATIONLINKSCOUNTPEROWNER
- See Also:
- Constant Field Values
-
ANNOTATIONLINKS
public static final java.lang.String ANNOTATIONLINKS
- See Also:
- Constant Field Values
-
DETAILS
public static final java.lang.String DETAILS
- See Also:
- Constant Field Values
-
FIELDS
public static final java.util.Set<java.lang.String> FIELDS
-
_dynamicFields
protected java.util.Map<java.lang.String,java.lang.Object> _dynamicFields
-
_loaded
protected boolean _loaded
-
-
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:IObject
usually 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:
getVersion
in interfaceIMutable
-
setVersion
public void setVersion(java.lang.Integer version)
Description copied from interface:IMutable
use with caution. In general, the version should only be altered by the backend. In the best case, an exception will be thrown for a version not equal to the current DB value. In the worst (though rare) case, the new version could match the database, and override optimistic lock checks that are supposed to prevent data loss.- Specified by:
setVersion
in interfaceIMutable
- Parameters:
version
- Value for this objects version.
-
getUsedFiles
protected java.util.List<FilesetEntry> getUsedFiles()
returns usedFiles . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many List ome.model.fs.Fileset.usedFiles (ome.model.fs.FilesetEntry) Values are indexed by the column "index" on ome.model.fs.FilesetEntry
-
setUsedFiles
protected void setUsedFiles(java.util.List<FilesetEntry> usedFiles)
setter for usedFiles should be avoided. Does not fulfill normal semantics.
-
sizeOfUsedFiles
public int sizeOfUsedFiles()
returns the size of usedFiles. If less than zero, the Set was null.
-
iterateUsedFiles
public java.util.Iterator<FilesetEntry> iterateUsedFiles()
should be used rather than accessing the usedFiles set directly. This method will never return null, but rather will return an instance ofEmptyIterator
. To test for a null collection, see ofsizeOfUsedFiles()
is less than zero.
-
unmodifiableUsedFiles
public java.util.Collection<FilesetEntry> unmodifiableUsedFiles()
Returns an unmodifiable collection-view
-
collectUsedFiles
public <E> java.util.List<E> collectUsedFiles(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.fs.FilesetEntry while collecting the results. Ifblock == null
, then the iterator values themselves are collected. This method usesiterateUsedFiles()
internally and so will return a value even if the underlying collection is null.
-
addFilesetEntry
public void addFilesetEntry(FilesetEntry target)
use instead of setUsedFiles . Makes the necessary call on ome.model.fs.FilesetEntry as well.
-
addFilesetEntrySet
public void addFilesetEntrySet(java.util.Collection<FilesetEntry> targets)
use like addFilesetEntry.
-
removeFilesetEntry
public void removeFilesetEntry(FilesetEntry target)
removes a single element from this set and makes the inverse call on ome.model.fs.FilesetEntry
-
removeFilesetEntrySet
public void removeFilesetEntrySet(java.util.Collection<FilesetEntry> targets)
use like removeFilesetEntry
-
clearUsedFiles
public void clearUsedFiles()
clears the set.
-
getFilesetEntry
public FilesetEntry getFilesetEntry(int index) throws java.lang.IndexOutOfBoundsException
Gets the ome.model.fs.FilesetEntry at the given index.- Throws:
java.lang.IndexOutOfBoundsException
-
setFilesetEntry
public FilesetEntry setFilesetEntry(int index, FilesetEntry element) throws java.lang.IndexOutOfBoundsException
Sets the ome.model.fs.FilesetEntry at the given index. Adheres to theList.set(int, Object)
contract. To extend the list, useaddFilesetEntry(FilesetEntry)
.- Throws:
java.lang.IndexOutOfBoundsException
- See Also:
List.set(int, Object)
-
getPrimaryFilesetEntry
public FilesetEntry getPrimaryFilesetEntry() throws java.lang.IndexOutOfBoundsException
Gets the first element of usedFiles which can be interpreted as the primary or default element in some situations. If there is not first element, anIndexOutOfBoundsException
is throws. This method will also throw anApiUsageException
if the collection is unloaded. SeesizeOfUsedFiles()
for more information.- Throws:
java.lang.IndexOutOfBoundsException
-
setPrimaryFilesetEntry
public FilesetEntry setPrimaryFilesetEntry(FilesetEntry element) throws java.lang.IndexOutOfBoundsException
Swaps the first element of usedFiles with the first instance of the given element. If the given element is not in the list, anIndexOutOfBoundsException
will be thrown. Returns the swapped element. This method will also throw anApiUsageException
if the collection is unloaded. SeesizeOfUsedFiles()
for more information.- Throws:
java.lang.IndexOutOfBoundsException
-
getImages
protected java.util.Set<Image> getImages()
returns images . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.fs.Fileset.images (ome.model.core.Image)
-
setImages
protected void setImages(java.util.Set<Image> images)
setter for images should be avoided. Does not fulfill normal semantics.
-
sizeOfImages
public int sizeOfImages()
returns the size of images. If less than zero, the Set was null.
-
iterateImages
public java.util.Iterator<Image> iterateImages()
should be used rather than accessing the images set directly. This method will never return null, but rather will return an instance ofEmptyIterator
. To test for a null collection, see ofsizeOfImages()
is less than zero.
-
unmodifiableImages
public java.util.Collection<Image> unmodifiableImages()
Returns an unmodifiable collection-view
-
collectImages
public <E> java.util.List<E> collectImages(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. This method usesiterateImages()
internally and so will return a value even if the underlying collection is null.
-
addImage
public void addImage(Image target)
use instead of setImages . Makes the necessary call on ome.model.core.Image as well.
-
addImageSet
public void addImageSet(java.util.Collection<Image> targets)
use like addImage.
-
removeImage
public void removeImage(Image target)
removes a single element from this set and makes the inverse call on ome.model.core.Image
-
removeImageSet
public void removeImageSet(java.util.Collection<Image> targets)
use like removeImage
-
clearImages
public void clearImages()
clears the set.
-
getJobLinks
protected java.util.List<FilesetJobLink> getJobLinks()
returns jobLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many List ome.model.fs.Fileset.jobLinks (ome.model.fs.FilesetJobLink) Values are indexed by the column "index" on ome.model.fs.FilesetJobLink
-
setJobLinks
protected void setJobLinks(java.util.List<FilesetJobLink> jobLinks)
setter for jobLinks should be avoided. Does not fulfill normal semantics.
-
sizeOfJobLinks
public int sizeOfJobLinks()
returns the size of jobLinks. If less than zero, the Set was null.
-
iterateJobLinks
public java.util.Iterator<FilesetJobLink> iterateJobLinks()
should be used rather than accessing the jobLinks set directly. This method will never return null, but rather will return an instance ofEmptyIterator
. To test for a null collection, see ofsizeOfJobLinks()
is less than zero.
-
unmodifiableJobLinks
public java.util.Collection<FilesetJobLink> unmodifiableJobLinks()
Returns an unmodifiable collection-view
-
collectJobLinks
public <E> java.util.List<E> collectJobLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.fs.FilesetJobLink while collecting the results. Ifblock == null
, then the iterator values themselves are collected. This method usesiterateJobLinks()
internally and so will return a value even if the underlying collection is null.
-
addFilesetJobLink
public void addFilesetJobLink(FilesetJobLink target)
use instead of setJobLinks . Makes the necessary call on ome.model.fs.FilesetJobLink as well.
-
addFilesetJobLinkSet
public void addFilesetJobLinkSet(java.util.Collection<FilesetJobLink> targets)
use like addFilesetJobLink.
-
removeFilesetJobLink
public void removeFilesetJobLink(FilesetJobLink target)
removes a single element from this set and makes the inverse call on ome.model.fs.FilesetJobLink
-
removeFilesetJobLinkSet
public void removeFilesetJobLinkSet(java.util.Collection<FilesetJobLink> targets)
use like removeFilesetJobLink
-
getFilesetJobLink
public FilesetJobLink getFilesetJobLink(int index) throws java.lang.IndexOutOfBoundsException
Gets the ome.model.fs.FilesetJobLink at the given index.- Throws:
java.lang.IndexOutOfBoundsException
-
setFilesetJobLink
public FilesetJobLink setFilesetJobLink(int index, FilesetJobLink element) throws java.lang.IndexOutOfBoundsException
Sets the ome.model.fs.FilesetJobLink at the given index. Adheres to theList.set(int, Object)
contract. To extend the list, useaddFilesetJobLink(FilesetJobLink)
.- Throws:
java.lang.IndexOutOfBoundsException
- See Also:
List.set(int, Object)
-
getPrimaryFilesetJobLink
public FilesetJobLink getPrimaryFilesetJobLink() throws java.lang.IndexOutOfBoundsException
Gets the first element of jobLinks which can be interpreted as the primary or default element in some situations. If there is not first element, anIndexOutOfBoundsException
is throws. This method will also throw anApiUsageException
if the collection is unloaded. SeesizeOfJobLinks()
for more information.- Throws:
java.lang.IndexOutOfBoundsException
-
setPrimaryFilesetJobLink
public FilesetJobLink setPrimaryFilesetJobLink(FilesetJobLink element) throws java.lang.IndexOutOfBoundsException
Swaps the first element of jobLinks with the first instance of the given element. If the given element is not in the list, anIndexOutOfBoundsException
will be thrown. Returns the swapped element. This method will also throw anApiUsageException
if the collection is unloaded. SeesizeOfJobLinks()
for more information.- Throws:
java.lang.IndexOutOfBoundsException
-
linkJob
public FilesetJobLink linkJob(Job addition)
Adds a ome.model.fs.FilesetJobLink to jobLinks . This entails changing our jobLinks Set, creating a new ome.model.fs.FilesetJobLink and calling linkJob on the ome.model.jobs.Job.
-
addFilesetJobLink
public void addFilesetJobLink(FilesetJobLink link, boolean bothSides)
Adds a ome.model.fs.FilesetJobLink to jobLinks, allowing for recursion -- whether or not addFilesetJobLink will be called on the addition if it is loaded
-
linkedJobIterator
public java.util.Iterator<Job> linkedJobIterator()
provides an iterator over the parent values of the jobLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in anConcurrentModificationException
. UselinkedJobList()
instead.
-
findFilesetJobLink
public java.util.Set<FilesetJobLink> findFilesetJobLink(Job target)
find all ome.model.fs.FilesetJobLink which have the argument as their child.
-
linkedJobList
public java.util.List<Job> linkedJobList()
produces aList
-copy of the underlying collection. Unlike,linkedJobIterator()
, while using the returnedList
, modifications can be made to the underlying collection without throwingConcurrentModificationException
.
-
eachLinkedJob
public <E> java.util.List<E> eachLinkedJob(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.jobs.Job while collecting the results. Ifblock == null
, then the iterator values themselves are collected.
-
unlinkJob
public void unlinkJob(Job removal)
unlinks all ome.model.jobs.Job instances from this instance.
-
removeFilesetJobLink
public void removeFilesetJobLink(FilesetJobLink link, boolean bothSides)
removes the given FilesetJobLink from jobLinks, allowing for recursion -- whether or not the removal will call unlinkFileset again if loaded.
-
clearJobLinks
public void clearJobLinks()
clears the set.
-
setJobLinksCountPerOwner
protected void setJobLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
-
getJobLinksCountPerOwner
public java.util.Map<java.lang.Long,java.lang.Long> getJobLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.fs.FilesetJobLink that a user has. If unfetched, returns null. No entries in the collection should be null.
-
getTemplatePrefix
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields") public java.lang.String getTemplatePrefix()
Simple field ome.model.fs.Fileset.templatePrefix (java.lang.String)
-
setTemplatePrefix
public void setTemplatePrefix(java.lang.String templatePrefix)
-
getAnnotationLinks
protected java.util.Set<FilesetAnnotationLink> 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.fs.Fileset.annotationLinks (ome.model.annotations.FilesetAnnotationLink)
-
setAnnotationLinks
protected void setAnnotationLinks(java.util.Set<FilesetAnnotationLink> 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 interfaceIAnnotated
-
iterateAnnotationLinks
public java.util.Iterator<FilesetAnnotationLink> 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:
iterateAnnotationLinks
in interfaceIAnnotated
-
unmodifiableAnnotationLinks
public java.util.Collection<FilesetAnnotationLink> unmodifiableAnnotationLinks()
Returns an unmodifiable collection-view- Specified by:
unmodifiableAnnotationLinks
in 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.FilesetAnnotationLink 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:
collectAnnotationLinks
in interfaceIAnnotated
-
addFilesetAnnotationLink
public void addFilesetAnnotationLink(FilesetAnnotationLink target)
use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.FilesetAnnotationLink as well.
-
addFilesetAnnotationLinkSet
public void addFilesetAnnotationLinkSet(java.util.Collection<FilesetAnnotationLink> targets)
use like addFilesetAnnotationLink.
-
removeFilesetAnnotationLink
public void removeFilesetAnnotationLink(FilesetAnnotationLink target)
removes a single element from this set and makes the inverse call on ome.model.annotations.FilesetAnnotationLink
-
removeFilesetAnnotationLinkSet
public void removeFilesetAnnotationLinkSet(java.util.Collection<FilesetAnnotationLink> targets)
use like removeFilesetAnnotationLink
-
linkAnnotation
public FilesetAnnotationLink linkAnnotation(Annotation addition)
Adds a ome.model.annotations.FilesetAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.FilesetAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.- Specified by:
linkAnnotation
in interfaceIAnnotated
-
addFilesetAnnotationLink
public void addFilesetAnnotationLink(FilesetAnnotationLink link, boolean bothSides)
Adds a ome.model.annotations.FilesetAnnotationLink to annotationLinks, allowing for recursion -- whether or not addFilesetAnnotationLink 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:
linkedAnnotationIterator
in interfaceIAnnotated
-
findFilesetAnnotationLink
public java.util.Set<FilesetAnnotationLink> findFilesetAnnotationLink(Annotation target)
find all ome.model.annotations.FilesetAnnotationLink 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:
linkedAnnotationList
in 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:
eachLinkedAnnotation
in interfaceIAnnotated
-
unlinkAnnotation
public void unlinkAnnotation(Annotation removal)
unlinks all ome.model.annotations.Annotation instances from this instance.- Specified by:
unlinkAnnotation
in interfaceIAnnotated
-
removeFilesetAnnotationLink
public void removeFilesetAnnotationLink(FilesetAnnotationLink link, boolean bothSides)
removes the given FilesetAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkFileset again if loaded.
-
clearAnnotationLinks
public void clearAnnotationLinks()
clears the set.- Specified by:
clearAnnotationLinks
in 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.FilesetAnnotationLink that a user has. If unfetched, returns null. No entries in the collection should be null.
-
getDetails
public Details getDetails()
The details of this object correspond to low-level system information. Owner, permissions, Details is always guaranteed to be non-null, unless the user actively nulls it. Every entity also contains a Detail reference, which doesn't refer to a separate table but rather to a collection of fields collected into a Hibernate "component" which is embedded in the object. HQL queries which refer to the Details component cannot directly fetch the entity like this: select o from Object join fetch o.details but rather each field of the Details instance must be explicitly joined: select o from Object join fetch o.details.owner It should also be noted that not all types have all the fields which are present on Details. For example, select e from Experimenter e join fetch e.details.owner will fail. Experimenter has no owner, for obvious reasons. Note: subclasses of this class will return a subclass of theDetails
type.- Specified by:
getDetails
in interfaceIObject
-
setDetails
protected void setDetails(Details details)
-
isValid
public boolean isValid()
Description copied from interface:IObject
calls the class-specific validator for this instance and returns the value fromValidation.isValid()
-
validate
public Validation validate()
Description copied from interface:IObject
calls the class-specific validator for this instance and returns theValidation
object.
-
newInstance
public Fileset newInstance()
-
proxy
public Fileset proxy()
-
acceptFilter
public boolean acceptFilter(Filter __filter)
- Specified by:
acceptFilter
in interfaceFilterable
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
fields
public java.util.Set<java.lang.String> fields()
Description copied from interface:IObject
returns a Set of field names that belong to this class
-
retrieve
public java.lang.Object retrieve(java.lang.String field)
Description copied from interface:IObject
retrieves a value from this instance. Values forfield
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 toIObject.putAt(String, Object)
-
putAt
public void putAt(java.lang.String field, java.lang.Object value)
Description copied from interface:IObject
stores a value in this instance. Values forfield
which 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: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.
-
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
-
getGraphHolder
public final GraphHolder getGraphHolder()
Description copied from interface:IObject
retrieves theGraphHolder
for this entity. If the GraphHolder has not been actively set, a new one will be instatiated.- Specified by:
getGraphHolder
in interfaceIObject
- Returns:
- Non-null GraphHolder
-
throwNullCollectionException
protected void throwNullCollectionException(java.lang.String propertyName)
-
-