PlateAcquisition (Bio-Formats API)

java.lang.Object
- ome.xml.model.AbstractOMEModelObject
- - ome.xml.model.PlateAcquisition

All Implemented Interfaces:: OMEModelObject

public class PlateAcquisition
extends AbstractOMEModelObject

Field Summary

Fields
Modifier and Type	Field and Description
`private List<Annotation>`	`annotationLinks`
`private String`	`description`
`private Timestamp`	`endTime`
`private String`	`id`
`private static org.slf4j.Logger`	`LOGGER` Logger for this class.
`private PositiveInteger`	`maximumFieldCount`
`private String`	`name`
`static String`	`NAMESPACE`
`private Plate`	`plate`
`private Timestamp`	`startTime`
`private List<WellSample>`	`wellSamples`

Constructor Summary

Constructors
Constructor and Description
`PlateAcquisition()` Default constructor.
`PlateAcquisition(Element element, OMEModel model)` Constructs PlateAcquisition recursively from an XML DOM tree.
`PlateAcquisition(PlateAcquisition orig)` Copy constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Element`	`asXMLElement(Document document)` Takes the entire object hierarchy and produces an XML DOM tree.
`protected Element`	`asXMLElement(Document document, Element PlateAcquisition_element)` Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`List<Annotation>`	`copyLinkedAnnotationList()`
`List<WellSample>`	`copyLinkedWellSampleList()`
`String`	`getDescription()`
`Timestamp`	`getEndTime()`
`String`	`getID()`
`Annotation`	`getLinkedAnnotation(int index)`
`WellSample`	`getLinkedWellSample(int index)`
`PositiveInteger`	`getMaximumFieldCount()`
`String`	`getName()`
`Plate`	`getPlate()`
`Timestamp`	`getStartTime()`
`boolean`	`link(Reference reference, OMEModelObject o)` Link a given OME model object to this model object.
`boolean`	`linkAnnotation(Annotation o)`
`boolean`	`linkWellSample(WellSample o)`
`void`	`setDescription(String description)`
`void`	`setEndTime(Timestamp endTime)`
`void`	`setID(String id)`
`Annotation`	`setLinkedAnnotation(int index, Annotation o)`
`WellSample`	`setLinkedWellSample(int index, WellSample o)`
`void`	`setMaximumFieldCount(PositiveInteger maximumFieldCount)`
`void`	`setName(String name)`
`void`	`setPlate(Plate plate_BackReference)`
`void`	`setStartTime(Timestamp startTime)`
`int`	`sizeOfLinkedAnnotationList()`
`int`	`sizeOfLinkedWellSampleList()`
`boolean`	`unlinkAnnotation(Annotation o)`
`boolean`	`unlinkWellSample(WellSample o)`
`void`	`update(Element element, OMEModel model)` Updates PlateAcquisition recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix

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

- Field Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    Constant Field Values
  - LOGGER
```
private static final org.slf4j.Logger LOGGER
```
    Logger for this class.
  - maximumFieldCount
```
private PositiveInteger maximumFieldCount
```
  - endTime
```
private Timestamp endTime
```
  - id
```
private String id
```
  - startTime
```
private Timestamp startTime
```
  - name
```
private String name
```
  - description
```
private String description
```
  - wellSamples
```
private List<WellSample> wellSamples
```
  - annotationLinks
```
private List<Annotation> annotationLinks
```
  - plate
```
private Plate plate
```
- Constructor Detail
  - PlateAcquisition
```
public PlateAcquisition()
```
    Default constructor.
  - PlateAcquisition
```
public PlateAcquisition(Element element,
                OMEModel model)
                 throws EnumerationException
```
    Constructs PlateAcquisition recursively from an XML DOM tree.
    
    Parameters:
    element - Root of the XML DOM tree to construct a model object graph from.
    model - Handler for the OME model which keeps track of instances and references seen during object population.
    
    Throws:
    
    EnumerationException - If there is an error instantiating an enumeration during model object creation.
  - PlateAcquisition
```
public PlateAcquisition(PlateAcquisition orig)
```
    Copy constructor.
- Method Detail
  - update
```
public void update(Element element,
          OMEModel model)
            throws EnumerationException
```
    Updates PlateAcquisition recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.
    
    Specified by:
    
    update in interface OMEModelObject
    
    Overrides:
    
    update in class AbstractOMEModelObject
    
    Parameters:
    element - Root of the XML DOM tree to construct a model object graph from.
    model - Handler for the OME model which keeps track of instances and references seen during object population.
    
    Throws:
    
    EnumerationException - If there is an error instantiating an enumeration during model object creation.
  - link
```
public boolean link(Reference reference,
           OMEModelObject o)
```
    Description copied from interface: OMEModelObject
    
    Link a given OME model object to this model object.
    
    Specified by:
    
    link in interface OMEModelObject
    
    Overrides:
    
    link in class AbstractOMEModelObject
    
    Parameters:
    reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.
    o - Model object to link to.
    
    Returns:
    true if this model object was able to handle the reference, false otherwise.
  - getMaximumFieldCount
```
public PositiveInteger getMaximumFieldCount()
```
  - setMaximumFieldCount
```
public void setMaximumFieldCount(PositiveInteger maximumFieldCount)
```
  - getEndTime
```
public Timestamp getEndTime()
```
  - setEndTime
```
public void setEndTime(Timestamp endTime)
```
  - getID
```
public String getID()
```
  - setID
```
public void setID(String id)
```
  - getStartTime
```
public Timestamp getStartTime()
```
  - setStartTime
```
public void setStartTime(Timestamp startTime)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getDescription
```
public String getDescription()
```
  - setDescription
```
public void setDescription(String description)
```
  - sizeOfLinkedWellSampleList
```
public int sizeOfLinkedWellSampleList()
```
  - copyLinkedWellSampleList
```
public List<WellSample> copyLinkedWellSampleList()
```
  - getLinkedWellSample
```
public WellSample getLinkedWellSample(int index)
```
  - setLinkedWellSample
```
public WellSample setLinkedWellSample(int index,
                             WellSample o)
```
  - linkWellSample
```
public boolean linkWellSample(WellSample o)
```
  - unlinkWellSample
```
public boolean unlinkWellSample(WellSample o)
```
  - sizeOfLinkedAnnotationList
```
public int sizeOfLinkedAnnotationList()
```
  - copyLinkedAnnotationList
```
public List<Annotation> copyLinkedAnnotationList()
```
  - getLinkedAnnotation
```
public Annotation getLinkedAnnotation(int index)
```
  - setLinkedAnnotation
```
public Annotation setLinkedAnnotation(int index,
                             Annotation o)
```
  - linkAnnotation
```
public boolean linkAnnotation(Annotation o)
```
  - unlinkAnnotation
```
public boolean unlinkAnnotation(Annotation o)
```
  - getPlate
```
public Plate getPlate()
```
  - setPlate
```
public void setPlate(Plate plate_BackReference)
```
  - asXMLElement
```
public Element asXMLElement(Document document)
```
    Description copied from interface: OMEModelObject
    
    Takes the entire object hierarchy and produces an XML DOM tree.
    
    Specified by:
    
    asXMLElement in interface OMEModelObject
    
    Specified by:
    
    asXMLElement in class AbstractOMEModelObject
    
    Parameters:
    document - Destination document for element creation, etc.
    
    Returns:
    XML DOM tree root element for this model object.
  - asXMLElement
```
protected Element asXMLElement(Document document,
                   Element PlateAcquisition_element)
```
    Description copied from class: AbstractOMEModelObject
    
    Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
    
    Overrides:
    
    asXMLElement in class AbstractOMEModelObject
    
    Parameters:
    document - Destination document for element creation, etc.
    PlateAcquisition_element - Element from the subclass. If null a new element will be created of this class.
    
    Returns:
    element populated with properties from this class.

Class PlateAcquisition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ome.xml.model.AbstractOMEModelObject

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

LOGGER

maximumFieldCount

endTime

id

startTime

name

description

wellSamples

annotationLinks

plate

Constructor Detail

PlateAcquisition

PlateAcquisition

PlateAcquisition

Method Detail

update

link

getMaximumFieldCount

setMaximumFieldCount

getEndTime

setEndTime

getID

setID

getStartTime

setStartTime

getName

setName

getDescription

setDescription

sizeOfLinkedWellSampleList

copyLinkedWellSampleList

getLinkedWellSample

setLinkedWellSample

linkWellSample

unlinkWellSample

sizeOfLinkedAnnotationList

copyLinkedAnnotationList

getLinkedAnnotation

setLinkedAnnotation

linkAnnotation

unlinkAnnotation

getPlate

setPlate

asXMLElement

asXMLElement