Details (OMERO API)

java.lang.Object
- ome.model.internal.Details

All Implemented Interfaces:

Serializable, Filterable

Direct Known Subclasses:

AcquisitionMode.Details, Annotation.Details, AnnotationAnnotationLink.Details, ArcType.Details, Binning.Details, Channel.Details, ChannelAnnotationLink.Details, ChannelBinding.Details, ChecksumAlgorithm.Details, CodomainMapContext.Details, ContrastMethod.Details, Correction.Details, Dataset.Details, DatasetAnnotationLink.Details, DatasetImageLink.Details, DBPatch.Details, Detector.Details, DetectorAnnotationLink.Details, DetectorSettings.Details, DetectorType.Details, Dichroic.Details, DichroicAnnotationLink.Details, DimensionOrder.Details, Event.Details, EventLog.Details, EventType.Details, Experiment.Details, Experimenter.Details, ExperimenterAnnotationLink.Details, ExperimenterGroup.Details, ExperimenterGroupAnnotationLink.Details, ExperimentType.Details, ExternalInfo.Details, Family.Details, FilamentType.Details, Fileset.Details, FilesetAnnotationLink.Details, FilesetEntry.Details, FilesetJobLink.Details, Filter.Details, FilterAnnotationLink.Details, FilterSet.Details, FilterSetEmissionFilterLink.Details, FilterSetExcitationFilterLink.Details, FilterType.Details, Format.Details, GroupExperimenterMap.Details, Illumination.Details, Image.Details, ImageAnnotationLink.Details, ImagingEnvironment.Details, Immersion.Details, Instrument.Details, InstrumentAnnotationLink.Details, Job.Details, JobOriginalFileLink.Details, JobStatus.Details, LaserMedium.Details, LaserType.Details, LightPath.Details, LightPathAnnotationLink.Details, LightPathEmissionFilterLink.Details, LightPathExcitationFilterLink.Details, LightSettings.Details, LightSource.Details, LightSourceAnnotationLink.Details, Link.Details, LogicalChannel.Details, Medium.Details, MicrobeamManipulation.Details, MicrobeamManipulationType.Details, Microscope.Details, MicroscopeType.Details, Namespace.Details, NamespaceAnnotationLink.Details, Node.Details, NodeAnnotationLink.Details, Objective.Details, ObjectiveAnnotationLink.Details, ObjectiveSettings.Details, OriginalFile.Details, OriginalFileAnnotationLink.Details, OTF.Details, PhotometricInterpretation.Details, Pixels.Details, PixelsOriginalFileMap.Details, PixelsType.Details, PlaneInfo.Details, PlaneInfoAnnotationLink.Details, Plate.Details, PlateAcquisition.Details, PlateAcquisitionAnnotationLink.Details, PlateAnnotationLink.Details, Project.Details, ProjectAnnotationLink.Details, ProjectDatasetLink.Details, Pulse.Details, QuantumDef.Details, Reagent.Details, ReagentAnnotationLink.Details, RenderingDef.Details, RenderingModel.Details, Roi.Details, RoiAnnotationLink.Details, Screen.Details, ScreenAnnotationLink.Details, ScreenPlateLink.Details, Session.Details, SessionAnnotationLink.Details, Shape.Details, ShapeAnnotationLink.Details, ShareMember.Details, StageLabel.Details, StatsInfo.Details, Thumbnail.Details, TransmittanceRange.Details, Well.Details, WellAnnotationLink.Details, WellReagentLink.Details, WellSample.Details
```
@MappedSuperclass
public abstract class Details
extends Object
implements Filterable, Serializable
```
value type for low-level (row-level) details for all IObject objects. Details instances are given special treatment through the Omero system, especially during ome.api.IUpdate update.

Since:

3.0

Version:

3.0

Author:

Josh Moore josh.moore@gmx.de

See Also:

"ome.api.IUpdate", Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected IObject`	`_context`
`protected Event`	`_creation`
`protected Map`	`_dynamicFields`
`protected ExternalInfo`	`_externalInfo`
`protected Set<String>`	`_filteredCollections`
`protected ExperimenterGroup`	`_group`
`protected Experimenter`	`_owner`
`protected Permissions`	`_perms`
`protected Event`	`_update`
`protected Object[]`	`contexts`
`static String`	`CREATIONEVENT`
`static String`	`EXTERNALINFO`
`static String`	`GROUP`
`static String`	`OWNER`
`static String`	`PERMISSIONS`
`static String`	`UPDATEEVENT`

Constructor Summary

Constructors
Constructor and Description

Details()
default constructor.

Details(Details copy)
copy-constructor

Details(Object[] contexts)

Constructors
Constructor and Description
`Details()` default constructor.
`Details(Details copy)` copy-constructor
`Details(Object[] contexts)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter filter)`
`void`	`addFiltered(Collection<String> collection)` consider all the collections named by the elements of collection to be a "filtered" representation of the DB.
`void`	`addFiltered(String collectionName)` consider the collection named by `collectionName` to be a "filtered" representation of the DB.
`void`	`clearFiltered()` all currently marked collections are released.
`Object`	`contextAt(int i)`
`Details`	`copy()`
`void`	`copy(Details copy)` Method which takes all field values from the given `Details` instance and copies them into the current instance.
`void`	`copyWhereUnset(Details mask, Details copyFrom)` For any field of this which is null (and is NOT null on mask -- assuming mask is not null), copy the same value from copyFrom into this object.
`static Details`	`create()` Call `create(Object[])` with null.
`static Details`	`create(Object[] contexts)` Factory method which returns a `Details` implementation for passing in API calls, but cannot be stored within an `IObject` instance.
`Set<String>`	`filteredSet()` copy of the current collection of filtered names.
`int`	`filteredSize()` the count of collections which were filtered.
`IObject`	`getContext()` reference to the entity which this Details is contained in.
`Event`	`getCreationEvent()`
`ExternalInfo`	`getExternalInfo()`
`ExperimenterGroup`	`getGroup()`
`Experimenter`	`getOwner()`
`Permissions`	`getPermissions()` Permissions is a component embedded into the Details component.
`Event`	`getUpdateEvent()`
`boolean`	`isFiltered(String collectionName)` Was this collection filtered during creation?
`abstract Details`	`newInstance()`
`void`	`putAt(String field, Object value)`
`Object`	`retrieve(String field)`
`void`	`setContext(IObject myContext)` set entity to which this Details belongs.
`void`	`setContexts(Object[] contexts)`
`void`	`setCreationEvent(Event e)`
`void`	`setExternalInfo(ExternalInfo info)`
`void`	`setGroup(ExperimenterGroup _group)`
`void`	`setOwner(Experimenter exp)`
`void`	`setPermissions(Permissions perms)`
`void`	`setUpdateEvent(Event e)`
`Details`	`shallowCopy()`
`void`	`shallowCopy(Details copy)` Method which takes all the fields of the given `Details` instance and sets unloaded proxies of them into the current instance.
`String`	`toString()` simple view of the Details.
`void`	`toString(StringBuilder sb)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PERMISSIONS
```
public static final String PERMISSIONS
```
    See Also:
    
    Constant Field Values
  - EXTERNALINFO
```
public static final String EXTERNALINFO
```
    See Also:
    
    Constant Field Values
  - CREATIONEVENT
```
public static final String CREATIONEVENT
```
    See Also:
    
    Constant Field Values
  - OWNER
```
public static final String OWNER
```
    See Also:
    
    Constant Field Values
  - GROUP
```
public static final String GROUP
```
    See Also:
    
    Constant Field Values
  - UPDATEEVENT
```
public static final String UPDATEEVENT
```
    See Also:
    
    Constant Field Values
  - _update
```
protected Event _update
```
  - _context
```
protected IObject _context
```
  - _perms
```
protected Permissions _perms
```
  - _externalInfo
```
protected ExternalInfo _externalInfo
```
  - _creation
```
protected Event _creation
```
  - _owner
```
protected Experimenter _owner
```
  - _group
```
protected ExperimenterGroup _group
```
  - _filteredCollections
```
protected Set<String> _filteredCollections
```
  - _dynamicFields
```
protected Map _dynamicFields
```
  - contexts
```
protected Object[] contexts
```
- Constructor Detail
  - Details
```
public Details()
```
    default constructor. Leaves values null to save resources.
  - Details
```
public Details(Object[] contexts)
```
  - Details
```
public Details(Details copy)
```
    copy-constructor
- Method Detail
  - create
```
public static final Details create()
```
    Call create(Object[]) with null.
  - create
```
public static final Details create(Object[] contexts)
```
    Factory method which returns a Details implementation for passing in API calls, but cannot be stored within an IObject instance. Use copy(Details) or shallowCopy(Details) instead.
  - contextAt
```
public Object contextAt(int i)
```
  - setContexts
```
public void setContexts(Object[] contexts)
```
  - shallowCopy
```
public Details shallowCopy()
```
  - copy
```
public Details copy()
```
  - copy
```
public void copy(Details copy)
```
    Method which takes all field values from the given Details instance and copies them into the current instance.
    
    Parameters:
    
    copy -
  - copyWhereUnset
```
public void copyWhereUnset(Details mask,
                           Details copyFrom)
```
    For any field of this which is null (and is NOT null on mask -- assuming mask is not null), copy the same value from copyFrom into this object.
    
    Parameters:
    
    mask -
    
    copyFrom -
  - shallowCopy
```
public void shallowCopy(Details copy)
```
    Method which takes all the fields of the given Details instance and sets unloaded proxies of them into the current instance.
  - addFiltered
```
public void addFiltered(String collectionName)
```
    consider the collection named by collectionName to be a "filtered" representation of the DB. This collection should not be saved, at most compared with the current DB to find added entities.
  - addFiltered
```
public void addFiltered(Collection<String> collection)
```
    consider all the collections named by the elements of collection to be a "filtered" representation of the DB. This collection should not be saved, at most compared with the current DB to find added entities.
  - isFiltered
```
public boolean isFiltered(String collectionName)
```
    Was this collection filtered during creation? If so, it should not be saved to the DB.
  - clearFiltered
```
public void clearFiltered()
```
    all currently marked collections are released. The space taken up by the collection is also released.
  - filteredSize
```
public int filteredSize()
```
    the count of collections which were filtered.
    
    Returns:
    
    number of String keys in the filtered set.
  - filteredSet
```
public Set<String> filteredSet()
```
    copy of the current collection of filtered names. Changes to this collection are not propagated.
    
    Returns:
    
    filtered set copy.
  - getContext
```
public IObject getContext()
```
    reference to the entity which this Details is contained in. This value is not maintained by the backend but is an internal mechanism.
  - setContext
```
public void setContext(IObject myContext)
```
    set entity to which this Details belongs. This may cause erratic behavior if called improperly.
    
    Parameters:
    
    myContext - entity which this Details belongs to
  - newInstance
```
public abstract Details newInstance()
```
  - toString
```
public String toString()
```
    simple view of the Details. Accesses only the ids of the contained entities
    
    Overrides:
    
    toString in class Object
  - toString
```
public void toString(StringBuilder sb)
```
  - getPermissions
```
public Permissions getPermissions()
```
    Permissions is a component embedded into the Details component. Similar rules apply as to Details, but it is not suggested that users attempt to directly query Permissions object as its internal state is not public.
  - setPermissions
```
public void setPermissions(Permissions perms)
```
  - getExternalInfo
```
public ExternalInfo getExternalInfo()
```
  - setExternalInfo
```
public void setExternalInfo(ExternalInfo info)
```
  - getOwner
```
public Experimenter getOwner()
```
  - setOwner
```
public void setOwner(Experimenter exp)
```
  - getCreationEvent
```
public Event getCreationEvent()
```
  - setCreationEvent
```
public void setCreationEvent(Event e)
```
  - getGroup
```
public ExperimenterGroup getGroup()
```
  - setGroup
```
public void setGroup(ExperimenterGroup _group)
```
  - getUpdateEvent
```
public Event getUpdateEvent()
```
  - setUpdateEvent
```
public void setUpdateEvent(Event e)
```
  - acceptFilter
```
public boolean acceptFilter(Filter filter)
```
    Specified by:
    
    acceptFilter in interface Filterable
  - retrieve
```
public Object retrieve(String field)
```
  - putAt
```
public void putAt(String field,
                  Object value)
```

Class Details

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PERMISSIONS

EXTERNALINFO

CREATIONEVENT

OWNER

GROUP

UPDATEEVENT

_update

_context

_perms

_externalInfo

_creation

_owner

_group

_filteredCollections

_dynamicFields

contexts

Constructor Detail

Details

Details

Details

Method Detail

create

create

contextAt

setContexts

shallowCopy

copy

copy

copyWhereUnset

shallowCopy

addFiltered

addFiltered

isFiltered

clearFiltered

filteredSize

filteredSet

getContext

setContext

newInstance

toString

toString

getPermissions

setPermissions

getExternalInfo

setExternalInfo

getOwner

setOwner

getCreationEvent

setCreationEvent

getGroup

setGroup

getUpdateEvent

setUpdateEvent

acceptFilter

retrieve

putAt