Package ome.model.core

Class Pixels

  • All Implemented Interfaces:
    java.io.Serializable, IMutable, IObject, Filterable
    @Entity
@Indexed(index="FullText")
@ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class Pixels
extends java.lang.Object
implements java.io.Serializable, IObject, IMutable
    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

      • image

        protected Image image

      • relatedTo

        @Deprecated
protected Pixels relatedTo
        Deprecated.

      • significantBits

        protected java.lang.Integer significantBits

      • sizeX

        protected java.lang.Integer sizeX

      • sizeY

        protected java.lang.Integer sizeY

      • sizeZ

        protected java.lang.Integer sizeZ

      • sizeC

        protected java.lang.Integer sizeC

      • sizeT

        protected java.lang.Integer sizeT

      • sha1

        protected java.lang.String sha1

      • physicalSizeX

        protected Length physicalSizeX

      • physicalSizeY

        protected Length physicalSizeY

      • physicalSizeZ

        protected Length physicalSizeZ

      • waveStart

        protected java.lang.Integer waveStart

      • waveIncrement

        protected java.lang.Integer waveIncrement

      • timeIncrement

        protected Time timeIncrement

      • methodology

        protected java.lang.String methodology

      • planeInfo

        protected java.util.Set<PlaneInfo> planeInfo

      • OWNER_FILTER_PLANEINFO

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

      • GROUP_FILTER_PLANEINFO

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

      • EVENT_FILTER_PLANEINFO

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

      • PERMS_FILTER_PLANEINFO

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

      • OWNER_FILTER_PIXELSFILEMAPS

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

      • GROUP_FILTER_PIXELSFILEMAPS

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

      • EVENT_FILTER_PIXELSFILEMAPS

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

      • PERMS_FILTER_PIXELSFILEMAPS

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

      • channels

        protected java.util.List<Channel> channels

      • OWNER_FILTER_CHANNELS

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

      • GROUP_FILTER_CHANNELS

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

      • EVENT_FILTER_CHANNELS

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

      • PERMS_FILTER_CHANNELS

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

      • OWNER_FILTER_SETTINGS

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

      • GROUP_FILTER_SETTINGS

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

      • EVENT_FILTER_SETTINGS

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

      • PERMS_FILTER_SETTINGS

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

      • thumbnails

        protected java.util.Set<Thumbnail> thumbnails

      • OWNER_FILTER_THUMBNAILS

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

      • GROUP_FILTER_THUMBNAILS

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

      • EVENT_FILTER_THUMBNAILS

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

      • PERMS_FILTER_THUMBNAILS

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

      • details

        protected Details details

      • RELATEDTO

        @Deprecated
public static final java.lang.String RELATEDTO
        Deprecated.
        See Also:
        Constant Field Values

      • PIXELSFILEMAPSCOUNTPEROWNER

        public static final java.lang.String PIXELSFILEMAPSCOUNTPEROWNER
        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

      • Pixels

        public Pixels()

      • Pixels

        protected Pixels​(java.lang.Long id)

      • Pixels

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

      • Pixels

        public Pixels​(Image _image,
              PixelsType _pixelsType,
              java.lang.Integer _sizeX,
              java.lang.Integer _sizeY,
              java.lang.Integer _sizeZ,
              java.lang.Integer _sizeC,
              java.lang.Integer _sizeT,
              java.lang.String _sha1,
              DimensionOrder _dimensionOrder)

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

      • getImage

        public Image getImage()
        Many-to-one field ome.model.core.Pixels.image (ome.model.core.Image)

      • setImage

        public void setImage​(Image image)

      • getRelatedTo

        @Deprecated
public Pixels getRelatedTo()
        Deprecated.
        Many-to-one field ome.model.core.Pixels.relatedTo (ome.model.core.Pixels)

      • setRelatedTo

        @Deprecated
public void setRelatedTo​(Pixels relatedTo)
        Deprecated.

      • getPixelsType

        public PixelsType getPixelsType()
        Many-to-one field ome.model.core.Pixels.pixelsType (ome.model.enums.PixelsType)

      • setPixelsType

        public void setPixelsType​(PixelsType pixelsType)

      • getSignificantBits

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

      • setSignificantBits

        public void setSignificantBits​(java.lang.Integer significantBits)

      • getSizeX

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

      • setSizeX

        public void setSizeX​(java.lang.Integer sizeX)

      • getSizeY

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

      • setSizeY

        public void setSizeY​(java.lang.Integer sizeY)

      • getSizeZ

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

      • setSizeZ

        public void setSizeZ​(java.lang.Integer sizeZ)

      • getSizeC

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

      • setSizeC

        public void setSizeC​(java.lang.Integer sizeC)

      • getSizeT

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

      • setSizeT

        public void setSizeT​(java.lang.Integer sizeT)

      • getSha1

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getSha1()
        Simple field ome.model.core.Pixels.sha1 (java.lang.String)

      • setSha1

        public void setSha1​(java.lang.String sha1)

      • getDimensionOrder

        public DimensionOrder getDimensionOrder()
        Many-to-one field ome.model.core.Pixels.dimensionOrder (ome.model.enums.DimensionOrder)

      • setDimensionOrder

        public void setDimensionOrder​(DimensionOrder dimensionOrder)

      • getPhysicalSizeX

        public Length getPhysicalSizeX()
        Enum-mapped unit-based field ome.model.core.Pixels.physicalSizeX (ome.model.units.Length)

      • setPhysicalSizeX

        public void setPhysicalSizeX​(Length physicalSizeX)

      • getPhysicalSizeY

        public Length getPhysicalSizeY()
        Enum-mapped unit-based field ome.model.core.Pixels.physicalSizeY (ome.model.units.Length)

      • setPhysicalSizeY

        public void setPhysicalSizeY​(Length physicalSizeY)

      • getPhysicalSizeZ

        public Length getPhysicalSizeZ()
        Enum-mapped unit-based field ome.model.core.Pixels.physicalSizeZ (ome.model.units.Length)

      • setPhysicalSizeZ

        public void setPhysicalSizeZ​(Length physicalSizeZ)

      • getWaveStart

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

      • setWaveStart

        public void setWaveStart​(java.lang.Integer waveStart)

      • getWaveIncrement

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

      • setWaveIncrement

        public void setWaveIncrement​(java.lang.Integer waveIncrement)

      • getTimeIncrement

        public Time getTimeIncrement()
        Enum-mapped unit-based field ome.model.core.Pixels.timeIncrement (ome.model.units.Time)

      • setTimeIncrement

        public void setTimeIncrement​(Time timeIncrement)

      • getMethodology

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getMethodology()
        Simple field ome.model.core.Pixels.methodology (java.lang.String)

      • setMethodology

        public void setMethodology​(java.lang.String methodology)

      • getPlaneInfo

        protected java.util.Set<PlaneInfo> getPlaneInfo()
        returns planeInfo . 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.Pixels.planeInfo (ome.model.core.PlaneInfo)

      • setPlaneInfo

        protected void setPlaneInfo​(java.util.Set<PlaneInfo> planeInfo)
        setter for planeInfo should be avoided. Does not fulfill normal semantics.

      • sizeOfPlaneInfo

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

      • iteratePlaneInfo

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

      • unmodifiablePlaneInfo

        public java.util.Collection<PlaneInfo> unmodifiablePlaneInfo()
        Returns an unmodifiable collection-view

      • collectPlaneInfo

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

      • addPlaneInfo

        public void addPlaneInfo​(PlaneInfo target)
        use instead of setPlaneInfo . Makes the necessary call on ome.model.core.PlaneInfo as well.

      • addPlaneInfoSet

        public void addPlaneInfoSet​(java.util.Collection<PlaneInfo> targets)
        use like addPlaneInfo.

      • removePlaneInfo

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

      • removePlaneInfoSet

        public void removePlaneInfoSet​(java.util.Collection<PlaneInfo> targets)
        use like removePlaneInfo

      • clearPlaneInfo

        public void clearPlaneInfo()
        clears the set.

      • getPixelsFileMaps

        protected java.util.Set<PixelsOriginalFileMap> getPixelsFileMaps()
        returns pixelsFileMaps . 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.Pixels.pixelsFileMaps (ome.model.core.PixelsOriginalFileMap)

      • setPixelsFileMaps

        protected void setPixelsFileMaps​(java.util.Set<PixelsOriginalFileMap> pixelsFileMaps)
        setter for pixelsFileMaps should be avoided. Does not fulfill normal semantics.

      • sizeOfPixelsFileMaps

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

      • iteratePixelsFileMaps

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

      • unmodifiablePixelsFileMaps

        public java.util.Collection<PixelsOriginalFileMap> unmodifiablePixelsFileMaps()
        Returns an unmodifiable collection-view

      • collectPixelsFileMaps

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

      • addPixelsOriginalFileMap

        public void addPixelsOriginalFileMap​(PixelsOriginalFileMap target)
        use instead of setPixelsFileMaps . Makes the necessary call on ome.model.core.PixelsOriginalFileMap as well.

      • addPixelsOriginalFileMapSet

        public void addPixelsOriginalFileMapSet​(java.util.Collection<PixelsOriginalFileMap> targets)
        use like addPixelsOriginalFileMap.

      • removePixelsOriginalFileMap

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

      • removePixelsOriginalFileMapSet

        public void removePixelsOriginalFileMapSet​(java.util.Collection<PixelsOriginalFileMap> targets)
        use like removePixelsOriginalFileMap

      • linkOriginalFile

        public PixelsOriginalFileMap linkOriginalFile​(OriginalFile addition)
        Adds a ome.model.core.PixelsOriginalFileMap to pixelsFileMaps . This entails changing our pixelsFileMaps Set, creating a new ome.model.core.PixelsOriginalFileMap and calling linkOriginalFile on the ome.model.core.OriginalFile.

      • addPixelsOriginalFileMap

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

      • linkedOriginalFileIterator

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

      • findPixelsOriginalFileMap

        public java.util.Set<PixelsOriginalFileMap> findPixelsOriginalFileMap​(OriginalFile target)
        find all ome.model.core.PixelsOriginalFileMap which have the argument as their parent.

      • linkedOriginalFileList

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

      • eachLinkedOriginalFile

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

      • unlinkOriginalFile

        public void unlinkOriginalFile​(OriginalFile removal)
        unlinks all ome.model.core.OriginalFile instances from this instance.

      • removePixelsOriginalFileMap

        public void removePixelsOriginalFileMap​(PixelsOriginalFileMap link,
                                        boolean bothSides)
        removes the given PixelsOriginalFileMap from pixelsFileMaps, allowing for recursion -- whether or not the removal will call unlinkPixels again if loaded.

      • clearOriginalFileLinks

        public void clearOriginalFileLinks()
        clears the set.

      • setPixelsFileMapsCountPerOwner

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

      • getPixelsFileMapsCountPerOwner

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

      • getChannels

        protected java.util.List<Channel> getChannels()
        returns channels . 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.Pixels.channels (ome.model.core.Channel) Values are indexed by the column "index" on ome.model.core.Channel

      • setChannels

        protected void setChannels​(java.util.List<Channel> channels)
        setter for channels should be avoided. Does not fulfill normal semantics.

      • sizeOfChannels

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

      • iterateChannels

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

      • unmodifiableChannels

        public java.util.Collection<Channel> unmodifiableChannels()
        Returns an unmodifiable collection-view

      • collectChannels

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

      • addChannel

        public void addChannel​(Channel target)
        use instead of setChannels . Makes the necessary call on ome.model.core.Channel as well.

      • addChannelSet

        public void addChannelSet​(java.util.Collection<Channel> targets)
        use like addChannel.

      • removeChannel

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

      • removeChannelSet

        public void removeChannelSet​(java.util.Collection<Channel> targets)
        use like removeChannel

      • clearChannels

        public void clearChannels()
        clears the set.

      • getChannel

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

      • setChannel

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

      • getPrimaryChannel

        public Channel getPrimaryChannel()
                          throws java.lang.IndexOutOfBoundsException
        Gets the first element of channels 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 sizeOfChannels() for more information.
        Throws:
        java.lang.IndexOutOfBoundsException

      • setPrimaryChannel

        public Channel setPrimaryChannel​(Channel element)
                          throws java.lang.IndexOutOfBoundsException
        Swaps the first element of channels 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 sizeOfChannels() for more information.
        Throws:
        java.lang.IndexOutOfBoundsException

      • getSettings

        protected java.util.Set<RenderingDef> getSettings()
        returns settings . 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.Pixels.settings (ome.model.display.RenderingDef)

      • setSettings

        protected void setSettings​(java.util.Set<RenderingDef> settings)
        setter for settings should be avoided. Does not fulfill normal semantics.

      • sizeOfSettings

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

      • iterateSettings

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

      • unmodifiableSettings

        public java.util.Collection<RenderingDef> unmodifiableSettings()
        Returns an unmodifiable collection-view

      • collectSettings

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

      • addRenderingDef

        public void addRenderingDef​(RenderingDef target)
        use instead of setSettings . Makes the necessary call on ome.model.display.RenderingDef as well.

      • addRenderingDefSet

        public void addRenderingDefSet​(java.util.Collection<RenderingDef> targets)
        use like addRenderingDef.

      • removeRenderingDef

        public void removeRenderingDef​(RenderingDef target)
        removes a single element from this set and makes the inverse call on ome.model.display.RenderingDef

      • removeRenderingDefSet

        public void removeRenderingDefSet​(java.util.Collection<RenderingDef> targets)
        use like removeRenderingDef

      • clearSettings

        public void clearSettings()
        clears the set.

      • getThumbnails

        protected java.util.Set<Thumbnail> getThumbnails()
        returns thumbnails . 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.Pixels.thumbnails (ome.model.display.Thumbnail)

      • setThumbnails

        protected void setThumbnails​(java.util.Set<Thumbnail> thumbnails)
        setter for thumbnails should be avoided. Does not fulfill normal semantics.

      • sizeOfThumbnails

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

      • iterateThumbnails

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

      • unmodifiableThumbnails

        public java.util.Collection<Thumbnail> unmodifiableThumbnails()
        Returns an unmodifiable collection-view

      • collectThumbnails

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

      • addThumbnail

        public void addThumbnail​(Thumbnail target)
        use instead of setThumbnails . Makes the necessary call on ome.model.display.Thumbnail as well.

      • addThumbnailSet

        public void addThumbnailSet​(java.util.Collection<Thumbnail> targets)
        use like addThumbnail.

      • removeThumbnail

        public void removeThumbnail​(Thumbnail target)
        removes a single element from this set and makes the inverse call on ome.model.display.Thumbnail

      • removeThumbnailSet

        public void removeThumbnailSet​(java.util.Collection<Thumbnail> targets)
        use like removeThumbnail

      • clearThumbnails

        public void clearThumbnails()
        clears the set.

      • 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 Pixels newInstance()

      • proxy

        public Pixels 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)