Package ome.model.acquisition

Class Microscope

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Microscope.Details  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean acceptFilter​(Filter __filter)  
      protected void errorIfUnloaded()  
      java.util.Set<java.lang.String> fields()
      returns a Set of field names that belong to this class
      Details getDetails()
      The details of this object correspond to low-level system information.
      GraphHolder getGraphHolder()
      retrieves the GraphHolder for this entity.
      java.lang.Long getId()
      The DB unique identifier for this object.
      java.lang.String getLotNumber()
      Simple field ome.model.acquisition.Microscope.lotNumber (java.lang.String)
      java.lang.String getManufacturer()
      Simple field ome.model.acquisition.Microscope.manufacturer (java.lang.String)
      java.lang.String getModel()
      Simple field ome.model.acquisition.Microscope.model (java.lang.String)
      java.lang.String getSerialNumber()
      Simple field ome.model.acquisition.Microscope.serialNumber (java.lang.String)
      MicroscopeType getType()
      Many-to-one field ome.model.acquisition.Microscope.type (ome.model.enums.MicroscopeType)
      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 from Validation.isValid()
      Microscope newInstance()  
      Microscope proxy()  
      void putAt​(java.lang.String field, java.lang.Object value)
      stores a value in this instance.
      java.lang.Object retrieve​(java.lang.String field)
      retrieves a value from this instance.
      protected void setDetails​(Details details)  
      void setId​(java.lang.Long id)
      usually unneeded.
      void setLotNumber​(java.lang.String lotNumber)  
      void setManufacturer​(java.lang.String manufacturer)  
      void setModel​(java.lang.String model)  
      void setSerialNumber​(java.lang.String serialNumber)  
      void setType​(MicroscopeType type)  
      void setVersion​(java.lang.Integer version)
      use with caution.
      protected void throwNullCollectionException​(java.lang.String propertyName)  
      java.lang.String toString()  
      void unload()
      set the loaded field to false, and set all non-ID fields to null.
      Validation validate()
      calls the class-specific validator for this instance and returns the Validation object.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • id

        protected java.lang.Long id

      • version

        protected java.lang.Integer version

      • manufacturer

        protected java.lang.String manufacturer

      • model

        protected java.lang.String model

      • lotNumber

        protected java.lang.String lotNumber

      • serialNumber

        protected java.lang.String serialNumber

      • details

        protected Details details

      • 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

      • Microscope

        public Microscope()

      • Microscope

        protected Microscope​(java.lang.Long id)

      • Microscope

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

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

      • getManufacturer

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getManufacturer()
        Simple field ome.model.acquisition.Microscope.manufacturer (java.lang.String)

      • setManufacturer

        public void setManufacturer​(java.lang.String manufacturer)

      • getModel

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getModel()
        Simple field ome.model.acquisition.Microscope.model (java.lang.String)

      • setModel

        public void setModel​(java.lang.String model)

      • getLotNumber

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getLotNumber()
        Simple field ome.model.acquisition.Microscope.lotNumber (java.lang.String)

      • setLotNumber

        public void setLotNumber​(java.lang.String lotNumber)

      • getSerialNumber

        @Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields")
public java.lang.String getSerialNumber()
        Simple field ome.model.acquisition.Microscope.serialNumber (java.lang.String)

      • setSerialNumber

        public void setSerialNumber​(java.lang.String serialNumber)

      • getType

        public MicroscopeType getType()
        Many-to-one field ome.model.acquisition.Microscope.type (ome.model.enums.MicroscopeType)

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

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