Package ome.model.core

Class Image

  • 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 Image
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

    • Field Detail

      • id

        protected java.lang.Long id

      • version

        protected java.lang.Integer version

      • series

        protected java.lang.Integer series

      • acquisitionDate

        protected java.sql.Timestamp acquisitionDate

      • archived

        protected java.lang.Boolean archived

      • partial

        protected java.lang.Boolean partial

      • format

        protected Format format

      • pixels

        protected java.util.List<Pixels> pixels

      • OWNER_FILTER_PIXELS

        public static final java.lang.String OWNER_FILTER_PIXELS
        See Also:
        Constant Field Values

      • GROUP_FILTER_PIXELS

        public static final java.lang.String GROUP_FILTER_PIXELS
        See Also:
        Constant Field Values

      • EVENT_FILTER_PIXELS

        public static final java.lang.String EVENT_FILTER_PIXELS
        See Also:
        Constant Field Values

      • PERMS_FILTER_PIXELS

        public static final java.lang.String PERMS_FILTER_PIXELS
        See Also:
        Constant Field Values

      • wellSamples

        protected java.util.Set<WellSample> wellSamples

      • OWNER_FILTER_WELLSAMPLES

        public static final java.lang.String OWNER_FILTER_WELLSAMPLES
        See Also:
        Constant Field Values

      • GROUP_FILTER_WELLSAMPLES

        public static final java.lang.String GROUP_FILTER_WELLSAMPLES
        See Also:
        Constant Field Values

      • EVENT_FILTER_WELLSAMPLES

        public static final java.lang.String EVENT_FILTER_WELLSAMPLES
        See Also:
        Constant Field Values

      • PERMS_FILTER_WELLSAMPLES

        public static final java.lang.String PERMS_FILTER_WELLSAMPLES
        See Also:
        Constant Field Values

      • rois

        protected java.util.Set<Roi> rois

      • OWNER_FILTER_ROIS

        public static final java.lang.String OWNER_FILTER_ROIS
        See Also:
        Constant Field Values

      • GROUP_FILTER_ROIS

        public static final java.lang.String GROUP_FILTER_ROIS
        See Also:
        Constant Field Values

      • EVENT_FILTER_ROIS

        public static final java.lang.String EVENT_FILTER_ROIS
        See Also:
        Constant Field Values

      • PERMS_FILTER_ROIS

        public static final java.lang.String PERMS_FILTER_ROIS
        See Also:
        Constant Field Values

      • OWNER_FILTER_DATASETLINKS

        public static final java.lang.String OWNER_FILTER_DATASETLINKS
        See Also:
        Constant Field Values

      • GROUP_FILTER_DATASETLINKS

        public static final java.lang.String GROUP_FILTER_DATASETLINKS
        See Also:
        Constant Field Values

      • EVENT_FILTER_DATASETLINKS

        public static final java.lang.String EVENT_FILTER_DATASETLINKS
        See Also:
        Constant Field Values

      • PERMS_FILTER_DATASETLINKS

        public static final java.lang.String PERMS_FILTER_DATASETLINKS
        See Also:
        Constant Field Values

      • OWNER_FILTER_FOLDERLINKS

        public static final java.lang.String OWNER_FILTER_FOLDERLINKS
        See Also:
        Constant Field Values

      • GROUP_FILTER_FOLDERLINKS

        public static final java.lang.String GROUP_FILTER_FOLDERLINKS
        See Also:
        Constant Field Values

      • EVENT_FILTER_FOLDERLINKS

        public static final java.lang.String EVENT_FILTER_FOLDERLINKS
        See Also:
        Constant Field Values

      • PERMS_FILTER_FOLDERLINKS

        public static final java.lang.String PERMS_FILTER_FOLDERLINKS
        See Also:
        Constant Field Values

      • fileset

        protected Fileset fileset

      • 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

      • IMAGINGENVIRONMENT

        public static final java.lang.String IMAGINGENVIRONMENT
        See Also:
        Constant Field Values

      • OBJECTIVESETTINGS

        public static final java.lang.String OBJECTIVESETTINGS
        See Also:
        Constant Field Values

      • DATASETLINKSCOUNTPEROWNER

        public static final java.lang.String DATASETLINKSCOUNTPEROWNER
        See Also:
        Constant Field Values

      • FOLDERLINKSCOUNTPEROWNER

        public static final java.lang.String FOLDERLINKSCOUNTPEROWNER
        See Also:
        Constant Field Values

      • ANNOTATIONLINKSCOUNTPEROWNER

        public static final java.lang.String ANNOTATIONLINKSCOUNTPEROWNER
        See Also:
        Constant Field Values

      • FIELDS

        public static final java.util.Set<java.lang.String> FIELDS

      • _dynamicFields

        protected java.util.Map<java.lang.String,​java.lang.Object> _dynamicFields

      • _loaded

        protected boolean _loaded

    • Constructor Detail

      • Image

        public Image()

      • Image

        protected Image​(java.lang.Long id)

      • Image

        public Image​(java.lang.Long id,
             boolean loaded)
        Main constructor.

      • Image

        public Image​(java.lang.String _name)

    • Method Detail

      • getId

        @DocumentId
public java.lang.Long getId()
        The DB unique identifier for this object. You are not responsible for setting the id; however, it can be useful for creating "unloaded" versions of your objects. Each top-level entity contains an id field of type long. For all objects returned from the server, this value will be non-null, which doesn't necessarily hold for the other fields.
        Specified by:
        getId in interface IObject
        Returns:
        Long primary key. May be null.

      • setId

        public void setId​(java.lang.Long id)
        Description copied from interface: IObject
        usually unneeded. Ids are managed by the backend.
        Specified by:
        setId in interface IObject
        Parameters:
        id - Long value for this id.

      • getVersion

        public java.lang.Integer getVersion()
        This version number is controlled by the database for optimisitic locking.
        Specified by:
        getVersion in interface IMutable

      • setVersion

        public void setVersion​(java.lang.Integer version)
        Description copied from interface: IMutable
        use with caution. In general, the version should only be altered by the backend. In the best case, an exception will be thrown for a version not equal to the current DB value. In the worst (though rare) case, the new version could match the database, and override optimistic lock checks that are supposed to prevent data loss.
        Specified by:
        setVersion in interface IMutable
        Parameters:
        version - Value for this objects version.

      • getSeries

        @Field(index=UN_TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.Integer getSeries()
        Simple field ome.model.core.Image.series (java.lang.Integer)

      • setSeries

        public void setSeries​(java.lang.Integer series)

      • getAcquisitionDate

        @DateBridge(resolution=MINUTE)
@Fields(@Field(index=UN_TOKENIZED))
public java.sql.Timestamp getAcquisitionDate()
        Simple field ome.model.core.Image.acquisitionDate (java.sql.Timestamp)

      • setAcquisitionDate

        public void setAcquisitionDate​(java.sql.Timestamp acquisitionDate)

      • getArchived

        public java.lang.Boolean getArchived()
        Simple field ome.model.core.Image.archived (java.lang.Boolean)

      • setArchived

        public void setArchived​(java.lang.Boolean archived)

      • getPartial

        public java.lang.Boolean getPartial()
        Simple field ome.model.core.Image.partial (java.lang.Boolean)

      • setPartial

        public void setPartial​(java.lang.Boolean partial)

      • getFormat

        public Format getFormat()
        Many-to-one field ome.model.core.Image.format (ome.model.enums.Format)

      • setFormat

        public void setFormat​(Format format)

      • getImagingEnvironment

        public ImagingEnvironment getImagingEnvironment()
        Many-to-one field ome.model.core.Image.imagingEnvironment (ome.model.acquisition.ImagingEnvironment)

      • setImagingEnvironment

        public void setImagingEnvironment​(ImagingEnvironment imagingEnvironment)

      • getObjectiveSettings

        public ObjectiveSettings getObjectiveSettings()
        Many-to-one field ome.model.core.Image.objectiveSettings (ome.model.acquisition.ObjectiveSettings)

      • setObjectiveSettings

        public void setObjectiveSettings​(ObjectiveSettings objectiveSettings)

      • getInstrument

        public Instrument getInstrument()
        Many-to-one field ome.model.core.Image.instrument (ome.model.acquisition.Instrument)

      • setInstrument

        public void setInstrument​(Instrument instrument)

      • getStageLabel

        public StageLabel getStageLabel()
        Many-to-one field ome.model.core.Image.stageLabel (ome.model.acquisition.StageLabel)

      • setStageLabel

        public void setStageLabel​(StageLabel stageLabel)

      • getExperiment

        public Experiment getExperiment()
        Many-to-one field ome.model.core.Image.experiment (ome.model.experiment.Experiment)

      • setExperiment

        public void setExperiment​(Experiment experiment)

      • getPixels

        protected java.util.List<Pixels> getPixels()
        returns pixels . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many List ome.model.core.Image.pixels (ome.model.core.Pixels) Values are indexed by the column "index" on ome.model.core.Pixels

      • setPixels

        protected void setPixels​(java.util.List<Pixels> pixels)
        setter for pixels should be avoided. Does not fulfill normal semantics.

      • sizeOfPixels

        public int sizeOfPixels()
        returns the size of pixels. If less than zero, the Set was null.

      • iteratePixels

        public java.util.Iterator<Pixels> iteratePixels()
        should be used rather than accessing the pixels set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfPixels() is less than zero.

      • unmodifiablePixels

        public java.util.Collection<Pixels> unmodifiablePixels()
        Returns an unmodifiable collection-view

      • collectPixels

        public <E> java.util.List<E> collectPixels​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.core.Pixels while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iteratePixels() internally and so will return a value even if the underlying collection is null.

      • addPixels

        public void addPixels​(Pixels target)
        use instead of setPixels . Makes the necessary call on ome.model.core.Pixels as well.

      • addPixelsSet

        public void addPixelsSet​(java.util.Collection<Pixels> targets)
        use like addPixels.

      • removePixels

        public void removePixels​(Pixels target)
        removes a single element from this set and makes the inverse call on ome.model.core.Pixels

      • removePixelsSet

        public void removePixelsSet​(java.util.Collection<Pixels> targets)
        use like removePixels

      • clearPixels

        public void clearPixels()
        clears the set.

      • getPixels

        public Pixels getPixels​(int index)
                 throws java.lang.IndexOutOfBoundsException
        Gets the ome.model.core.Pixels at the given index.
        Throws:
        java.lang.IndexOutOfBoundsException

      • setPixels

        public Pixels setPixels​(int index,
                        Pixels element)
                 throws java.lang.IndexOutOfBoundsException
        Sets the ome.model.core.Pixels at the given index. Adheres to the List.set(int, Object) contract. To extend the list, use addPixels(Pixels).
        Throws:
        java.lang.IndexOutOfBoundsException
        See Also:
        List.set(int, Object)

      • getPrimaryPixels

        public Pixels getPrimaryPixels()
                        throws java.lang.IndexOutOfBoundsException
        Gets the first element of pixels which can be interpreted as the primary or default element in some situations. If there is not first element, an IndexOutOfBoundsException is throws. This method will also throw an ApiUsageException if the collection is unloaded. See sizeOfPixels() for more information.
        Throws:
        java.lang.IndexOutOfBoundsException

      • setPrimaryPixels

        public Pixels setPrimaryPixels​(Pixels element)
                        throws java.lang.IndexOutOfBoundsException
        Swaps the first element of pixels with the first instance of the given element. If the given element is not in the list, an IndexOutOfBoundsException will be thrown. Returns the swapped element. This method will also throw an ApiUsageException if the collection is unloaded. See sizeOfPixels() for more information.
        Throws:
        java.lang.IndexOutOfBoundsException

      • getWellSamples

        protected java.util.Set<WellSample> getWellSamples()
        returns wellSamples . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.core.Image.wellSamples (ome.model.screen.WellSample)

      • setWellSamples

        protected void setWellSamples​(java.util.Set<WellSample> wellSamples)
        setter for wellSamples should be avoided. Does not fulfill normal semantics.

      • sizeOfWellSamples

        public int sizeOfWellSamples()
        returns the size of wellSamples. If less than zero, the Set was null.

      • iterateWellSamples

        public java.util.Iterator<WellSample> iterateWellSamples()
        should be used rather than accessing the wellSamples set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfWellSamples() is less than zero.

      • unmodifiableWellSamples

        public java.util.Collection<WellSample> unmodifiableWellSamples()
        Returns an unmodifiable collection-view

      • collectWellSamples

        public <E> java.util.List<E> collectWellSamples​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.screen.WellSample while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateWellSamples() internally and so will return a value even if the underlying collection is null.

      • addWellSample

        public void addWellSample​(WellSample target)
        use instead of setWellSamples . Makes the necessary call on ome.model.screen.WellSample as well.

      • addWellSampleSet

        public void addWellSampleSet​(java.util.Collection<WellSample> targets)
        use like addWellSample.

      • removeWellSample

        public void removeWellSample​(WellSample target)
        removes a single element from this set and makes the inverse call on ome.model.screen.WellSample

      • removeWellSampleSet

        public void removeWellSampleSet​(java.util.Collection<WellSample> targets)
        use like removeWellSample

      • clearWellSamples

        public void clearWellSamples()
        clears the set.

      • getRois

        protected java.util.Set<Roi> getRois()
        returns rois . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.core.Image.rois (ome.model.roi.Roi)

      • setRois

        protected void setRois​(java.util.Set<Roi> rois)
        setter for rois should be avoided. Does not fulfill normal semantics.

      • sizeOfRois

        public int sizeOfRois()
        returns the size of rois. If less than zero, the Set was null.

      • iterateRois

        public java.util.Iterator<Roi> iterateRois()
        should be used rather than accessing the rois set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfRois() is less than zero.

      • unmodifiableRois

        public java.util.Collection<Roi> unmodifiableRois()
        Returns an unmodifiable collection-view

      • collectRois

        public <E> java.util.List<E> collectRois​(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. This method uses iterateRois() internally and so will return a value even if the underlying collection is null.

      • addRoi

        public void addRoi​(Roi target)
        use instead of setRois . Makes the necessary call on ome.model.roi.Roi as well.

      • addRoiSet

        public void addRoiSet​(java.util.Collection<Roi> targets)
        use like addRoi.

      • removeRoi

        public void removeRoi​(Roi target)
        removes a single element from this set and makes the inverse call on ome.model.roi.Roi

      • removeRoiSet

        public void removeRoiSet​(java.util.Collection<Roi> targets)
        use like removeRoi

      • clearRois

        public void clearRois()
        clears the set.

      • getDatasetLinks

        protected java.util.Set<DatasetImageLink> getDatasetLinks()
        returns datasetLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.core.Image.datasetLinks (ome.model.containers.DatasetImageLink)

      • setDatasetLinks

        protected void setDatasetLinks​(java.util.Set<DatasetImageLink> datasetLinks)
        setter for datasetLinks should be avoided. Does not fulfill normal semantics.

      • sizeOfDatasetLinks

        public int sizeOfDatasetLinks()
        returns the size of datasetLinks. If less than zero, the Set was null.

      • iterateDatasetLinks

        public java.util.Iterator<DatasetImageLink> iterateDatasetLinks()
        should be used rather than accessing the datasetLinks set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfDatasetLinks() is less than zero.

      • unmodifiableDatasetLinks

        public java.util.Collection<DatasetImageLink> unmodifiableDatasetLinks()
        Returns an unmodifiable collection-view

      • collectDatasetLinks

        public <E> java.util.List<E> collectDatasetLinks​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.containers.DatasetImageLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateDatasetLinks() internally and so will return a value even if the underlying collection is null.

      • addDatasetImageLink

        public void addDatasetImageLink​(DatasetImageLink target)
        use instead of setDatasetLinks . Makes the necessary call on ome.model.containers.DatasetImageLink as well.

      • addDatasetImageLinkSet

        public void addDatasetImageLinkSet​(java.util.Collection<DatasetImageLink> targets)
        use like addDatasetImageLink.

      • removeDatasetImageLink

        public void removeDatasetImageLink​(DatasetImageLink target)
        removes a single element from this set and makes the inverse call on ome.model.containers.DatasetImageLink

      • removeDatasetImageLinkSet

        public void removeDatasetImageLinkSet​(java.util.Collection<DatasetImageLink> targets)
        use like removeDatasetImageLink

      • linkDataset

        public DatasetImageLink linkDataset​(Dataset addition)
        Adds a ome.model.containers.DatasetImageLink to datasetLinks . This entails changing our datasetLinks Set, creating a new ome.model.containers.DatasetImageLink and calling linkDataset on the ome.model.containers.Dataset.

      • addDatasetImageLink

        public void addDatasetImageLink​(DatasetImageLink link,
                                boolean bothSides)
        Adds a ome.model.containers.DatasetImageLink to datasetLinks, allowing for recursion -- whether or not addDatasetImageLink will be called on the addition if it is loaded

      • linkedDatasetIterator

        public java.util.Iterator<Dataset> linkedDatasetIterator()
        provides an iterator over the child values of the datasetLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedDatasetList() instead.

      • findDatasetImageLink

        public java.util.Set<DatasetImageLink> findDatasetImageLink​(Dataset target)
        find all ome.model.containers.DatasetImageLink which have the argument as their parent.

      • linkedDatasetList

        public java.util.List<Dataset> linkedDatasetList()
        produces a List-copy of the underlying collection. Unlike, linkedDatasetIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.

      • eachLinkedDataset

        public <E> java.util.List<E> eachLinkedDataset​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.containers.Dataset while collecting the results. If block == null, then the iterator values themselves are collected.

      • unlinkDataset

        public void unlinkDataset​(Dataset removal)
        unlinks all ome.model.containers.Dataset instances from this instance.

      • removeDatasetImageLink

        public void removeDatasetImageLink​(DatasetImageLink link,
                                   boolean bothSides)
        removes the given DatasetImageLink from datasetLinks, allowing for recursion -- whether or not the removal will call unlinkImage again if loaded.

      • clearDatasetLinks

        public void clearDatasetLinks()
        clears the set.

      • setDatasetLinksCountPerOwner

        protected void setDatasetLinksCountPerOwner​(java.util.Map<java.lang.Long,​java.lang.Long> map)

      • getDatasetLinksCountPerOwner

        public java.util.Map<java.lang.Long,​java.lang.Long> getDatasetLinksCountPerOwner()
        If fetched, returns the count(*) of ome.model.containers.DatasetImageLink that a user has. If unfetched, returns null. No entries in the collection should be null.

      • getFolderLinks

        protected java.util.Set<FolderImageLink> getFolderLinks()
        returns folderLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.core.Image.folderLinks (ome.model.containers.FolderImageLink)

      • setFolderLinks

        protected void setFolderLinks​(java.util.Set<FolderImageLink> folderLinks)
        setter for folderLinks should be avoided. Does not fulfill normal semantics.

      • sizeOfFolderLinks

        public int sizeOfFolderLinks()
        returns the size of folderLinks. If less than zero, the Set was null.

      • iterateFolderLinks

        public java.util.Iterator<FolderImageLink> iterateFolderLinks()
        should be used rather than accessing the folderLinks set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfFolderLinks() is less than zero.

      • unmodifiableFolderLinks

        public java.util.Collection<FolderImageLink> unmodifiableFolderLinks()
        Returns an unmodifiable collection-view

      • collectFolderLinks

        public <E> java.util.List<E> collectFolderLinks​(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 iterateFolderLinks() internally and so will return a value even if the underlying collection is null.

      • addFolderImageLink

        public void addFolderImageLink​(FolderImageLink target)
        use instead of setFolderLinks . 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

      • linkFolder

        public FolderImageLink linkFolder​(Folder addition)
        Adds a ome.model.containers.FolderImageLink to folderLinks . This entails changing our folderLinks Set, creating a new ome.model.containers.FolderImageLink and calling linkFolder on the ome.model.containers.Folder.

      • addFolderImageLink

        public void addFolderImageLink​(FolderImageLink link,
                               boolean bothSides)
        Adds a ome.model.containers.FolderImageLink to folderLinks, allowing for recursion -- whether or not addFolderImageLink will be called on the addition if it is loaded

      • linkedFolderIterator

        public java.util.Iterator<Folder> linkedFolderIterator()
        provides an iterator over the child values of the folderLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedFolderList() instead.

      • findFolderImageLink

        public java.util.Set<FolderImageLink> findFolderImageLink​(Folder target)
        find all ome.model.containers.FolderImageLink which have the argument as their parent.

      • linkedFolderList

        public java.util.List<Folder> linkedFolderList()
        produces a List-copy of the underlying collection. Unlike, linkedFolderIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.

      • eachLinkedFolder

        public <E> java.util.List<E> eachLinkedFolder​(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.

      • unlinkFolder

        public void unlinkFolder​(Folder removal)
        unlinks all ome.model.containers.Folder instances from this instance.

      • removeFolderImageLink

        public void removeFolderImageLink​(FolderImageLink link,
                                  boolean bothSides)
        removes the given FolderImageLink from folderLinks, allowing for recursion -- whether or not the removal will call unlinkImage again if loaded.

      • clearFolderLinks

        public void clearFolderLinks()
        clears the set.

      • setFolderLinksCountPerOwner

        protected void setFolderLinksCountPerOwner​(java.util.Map<java.lang.Long,​java.lang.Long> map)

      • getFolderLinksCountPerOwner

        public java.util.Map<java.lang.Long,​java.lang.Long> getFolderLinksCountPerOwner()
        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.

      • getFileset

        public Fileset getFileset()
        Many-to-one field ome.model.core.Image.fileset (ome.model.fs.Fileset)

      • setFileset

        public void setFileset​(Fileset fileset)

      • getAnnotationLinks

        protected java.util.Set<ImageAnnotationLink> 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.core.Image.annotationLinks (ome.model.annotations.ImageAnnotationLink)

      • setAnnotationLinks

        protected void setAnnotationLinks​(java.util.Set<ImageAnnotationLink> 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

      • collectAnnotationLinks

        public <E> java.util.List<E> collectAnnotationLinks​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.annotations.ImageAnnotationLink 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

      • addImageAnnotationLink

        public void addImageAnnotationLink​(ImageAnnotationLink target)
        use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.ImageAnnotationLink as well.

      • addImageAnnotationLinkSet

        public void addImageAnnotationLinkSet​(java.util.Collection<ImageAnnotationLink> targets)
        use like addImageAnnotationLink.

      • removeImageAnnotationLink

        public void removeImageAnnotationLink​(ImageAnnotationLink target)
        removes a single element from this set and makes the inverse call on ome.model.annotations.ImageAnnotationLink

      • removeImageAnnotationLinkSet

        public void removeImageAnnotationLinkSet​(java.util.Collection<ImageAnnotationLink> targets)
        use like removeImageAnnotationLink

      • linkAnnotation

        public ImageAnnotationLink linkAnnotation​(Annotation addition)
        Adds a ome.model.annotations.ImageAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.ImageAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.
        Specified by:
        linkAnnotation in interface IAnnotated

      • addImageAnnotationLink

        public void addImageAnnotationLink​(ImageAnnotationLink link,
                                   boolean bothSides)
        Adds a ome.model.annotations.ImageAnnotationLink to annotationLinks, allowing for recursion -- whether or not addImageAnnotationLink will be called on the addition if it is loaded

      • linkedAnnotationIterator

        public java.util.Iterator<Annotation> linkedAnnotationIterator()
        provides an iterator over the parent values of the annotationLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedAnnotationList() instead.
        Specified by:
        linkedAnnotationIterator in interface IAnnotated

      • findImageAnnotationLink

        public java.util.Set<ImageAnnotationLink> findImageAnnotationLink​(Annotation target)
        find all ome.model.annotations.ImageAnnotationLink which have the argument as their child.

      • linkedAnnotationList

        public java.util.List<Annotation> linkedAnnotationList()
        produces a List-copy of the underlying collection. Unlike, linkedAnnotationIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
        Specified by:
        linkedAnnotationList in interface IAnnotated

      • eachLinkedAnnotation

        public <E> java.util.List<E> eachLinkedAnnotation​(CBlock<E> block)
        takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results. If block == null, then the iterator values themselves are collected.
        Specified by:
        eachLinkedAnnotation in interface IAnnotated

      • unlinkAnnotation

        public void unlinkAnnotation​(Annotation removal)
        unlinks all ome.model.annotations.Annotation instances from this instance.
        Specified by:
        unlinkAnnotation in interface IAnnotated

      • removeImageAnnotationLink

        public void removeImageAnnotationLink​(ImageAnnotationLink link,
                                      boolean bothSides)
        removes the given ImageAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkImage again if loaded.

      • 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.ImageAnnotationLink 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.core.Image.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.core.Image.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 the Details type.
        Specified by:
        getDetails in interface IObject

      • setDetails

        protected void setDetails​(Details details)

      • isValid

        public boolean isValid()
        Description copied from interface: IObject
        calls the class-specific validator for this instance and returns the value from Validation.isValid()
        Specified by:
        isValid in interface IObject

      • validate

        public Validation validate()
        Description copied from interface: IObject
        calls the class-specific validator for this instance and returns the Validation object.
        Specified by:
        validate in interface IObject
        Returns:
        Validation collecting parameter.

      • newInstance

        public Image newInstance()

      • proxy

        public Image proxy()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • fields

        public java.util.Set<java.lang.String> fields()
        Description copied from interface: IObject
        returns a Set of field names that belong to this class
        Specified by:
        fields in interface IObject

      • retrieve

        public java.lang.Object retrieve​(java.lang.String field)
        Description copied from interface: IObject
        retrieves a value from this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be retrieved from a lazy-loaded map filled by calls to IObject.putAt(String, Object)
        Specified by:
        retrieve in interface IObject

      • putAt

        public void putAt​(java.lang.String field,
                  java.lang.Object value)
        Description copied from interface: IObject
        stores a value in this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be stored in a lazy-loaded map.
        Specified by:
        putAt in interface IObject
        Parameters:
        field - Field name
        value - Any object to be stored.

      • isLoaded

        public boolean isLoaded()
        Description copied from interface: IObject
        transient field (not stored in the DB) which specifies whether this object has been loaded from the DB or is only a wrapper around the ID.
        Specified by:
        isLoaded in interface IObject

      • errorIfUnloaded

        protected void errorIfUnloaded()

      • unload

        public void unload()
        Description copied from interface: IObject
        set the loaded field to false, and set all non-ID fields to null. Subsequent calls to all accessors other than getId/setId will throw an ApiUsageException
        Specified by:
        unload in interface IObject

      • getGraphHolder

        public final GraphHolder getGraphHolder()
        Description copied from interface: IObject
        retrieves the GraphHolder for this entity. If the GraphHolder has not been actively set, a new one will be instatiated.
        Specified by:
        getGraphHolder in interface IObject
        Returns:
        Non-null GraphHolder

      • throwNullCollectionException

        protected void throwNullCollectionException​(java.lang.String propertyName)