Package ome.model.enums
Class PhotometricInterpretation
- java.lang.Object
-
- ome.model.enums.PhotometricInterpretation
-
- All Implemented Interfaces:
java.io.Serializable
,IEnum
,IGlobal
,IObject
,Filterable
@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class PhotometricInterpretation extends java.lang.Object implements java.io.Serializable, IObject, IGlobal, IEnum
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PhotometricInterpretation.Details
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<java.lang.String,java.lang.Object>
_dynamicFields
protected boolean
_loaded
protected Details
details
static java.lang.String
DETAILS
static java.util.Set<java.lang.String>
FIELDS
protected java.lang.Long
id
static java.lang.String
ID
protected java.lang.String
value
static java.lang.String
VALUE
static java.lang.String
VALUE_ARGB
static java.lang.String
VALUE_CMYK
static java.lang.String
VALUE_COLOR_MAP
static java.lang.String
VALUE_HSV
static java.lang.String
VALUE_MONOCHROME
static java.lang.String
VALUE_RGB
-
Constructor Summary
Constructors Modifier Constructor Description PhotometricInterpretation()
protected
PhotometricInterpretation(java.lang.Long id)
PhotometricInterpretation(java.lang.Long id, boolean loaded)
Main constructor.PhotometricInterpretation(java.lang.String value)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
acceptFilter(Filter __filter)
boolean
equals(java.lang.Object other)
protected void
errorIfUnloaded()
java.util.Set<java.lang.String>
fields()
returns a Set of field names that belong to this classDetails
getDetails()
The details of this object correspond to low-level system information.GraphHolder
getGraphHolder()
retrieves theGraphHolder
for this entity.java.lang.Long
getId()
The DB unique identifier for this object.java.lang.String
getValue()
Simple field ome.model.enums.PhotometricInterpretation.value (java.lang.String)int
hashCode()
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()
PhotometricInterpretation
newInstance()
PhotometricInterpretation
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
setValue(java.lang.String value)
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 theValidation
object.
-
-
-
Field Detail
-
VALUE_RGB
public static final java.lang.String VALUE_RGB
- See Also:
- Constant Field Values
-
VALUE_ARGB
public static final java.lang.String VALUE_ARGB
- See Also:
- Constant Field Values
-
VALUE_CMYK
public static final java.lang.String VALUE_CMYK
- See Also:
- Constant Field Values
-
VALUE_HSV
public static final java.lang.String VALUE_HSV
- See Also:
- Constant Field Values
-
VALUE_MONOCHROME
public static final java.lang.String VALUE_MONOCHROME
- See Also:
- Constant Field Values
-
VALUE_COLOR_MAP
public static final java.lang.String VALUE_COLOR_MAP
- See Also:
- Constant Field Values
-
ID
public static final java.lang.String ID
- See Also:
- Constant Field Values
-
id
protected java.lang.Long id
-
value
protected java.lang.String value
-
details
protected Details details
-
VALUE
public static final java.lang.String VALUE
- 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
-
-
Constructor Detail
-
PhotometricInterpretation
public PhotometricInterpretation()
-
PhotometricInterpretation
protected PhotometricInterpretation(java.lang.Long id)
-
PhotometricInterpretation
public PhotometricInterpretation(java.lang.Long id, boolean loaded)
Main constructor.
-
PhotometricInterpretation
public PhotometricInterpretation(java.lang.String value)
-
-
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.
-
getValue
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields") public java.lang.String getValue()
Simple field ome.model.enums.PhotometricInterpretation.value (java.lang.String)
-
setValue
public void setValue(java.lang.String value)
-
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 PhotometricInterpretation newInstance()
-
proxy
public PhotometricInterpretation 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)
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-