Screen (Bio-Formats API)

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

All Implemented Interfaces:: OMEModelObject

public class Screen
extends AbstractOMEModelObject

Field Summary

Fields
Modifier and Type	Field and Description
`private List<Annotation>`	`annotationLinks`
`private String`	`description`
`private String`	`id`
`private static org.slf4j.Logger`	`LOGGER` Logger for this class.
`private String`	`name`
`static String`	`NAMESPACE`
`private List<Plate>`	`plateLinks`
`private String`	`protocolDescription`
`private String`	`protocolIdentifier`
`private List<Reagent>`	`reagents`
`private String`	`reagentSetDescription`
`private String`	`reagentSetIdentifier`
`private String`	`type`

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addReagent(Reagent reagent)`
`Element`	`asXMLElement(Document document)` Takes the entire object hierarchy and produces an XML DOM tree.
`protected Element`	`asXMLElement(Document document, Element Screen_element)` Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`List<Annotation>`	`copyLinkedAnnotationList()`
`List<Plate>`	`copyLinkedPlateList()`
`List<Reagent>`	`copyReagentList()`
`String`	`getDescription()`
`String`	`getID()`
`Annotation`	`getLinkedAnnotation(int index)`
`Plate`	`getLinkedPlate(int index)`
`String`	`getName()`
`String`	`getProtocolDescription()`
`String`	`getProtocolIdentifier()`
`Reagent`	`getReagent(int index)`
`String`	`getReagentSetDescription()`
`String`	`getReagentSetIdentifier()`
`String`	`getType()`
`boolean`	`link(Reference reference, OMEModelObject o)` Link a given OME model object to this model object.
`boolean`	`linkAnnotation(Annotation o)`
`boolean`	`linkPlate(Plate o)`
`void`	`removeReagent(Reagent reagent)`
`void`	`setDescription(String description)`
`void`	`setID(String id)`
`Annotation`	`setLinkedAnnotation(int index, Annotation o)`
`Plate`	`setLinkedPlate(int index, Plate o)`
`void`	`setName(String name)`
`void`	`setProtocolDescription(String protocolDescription)`
`void`	`setProtocolIdentifier(String protocolIdentifier)`
`Reagent`	`setReagent(int index, Reagent reagent)`
`void`	`setReagentSetDescription(String reagentSetDescription)`
`void`	`setReagentSetIdentifier(String reagentSetIdentifier)`
`void`	`setType(String type)`
`int`	`sizeOfLinkedAnnotationList()`
`int`	`sizeOfLinkedPlateList()`
`int`	`sizeOfReagentList()`
`boolean`	`unlinkAnnotation(Annotation o)`
`boolean`	`unlinkPlate(Plate o)`
`void`	`update(Element element, OMEModel model)` Updates Screen 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.
  - name
```
private String name
```
  - protocolDescription
```
private String protocolDescription
```
  - protocolIdentifier
```
private String protocolIdentifier
```
  - reagentSetDescription
```
private String reagentSetDescription
```
  - type
```
private String type
```
  - id
```
private String id
```
  - reagentSetIdentifier
```
private String reagentSetIdentifier
```
  - description
```
private String description
```
  - reagents
```
private List<Reagent> reagents
```
  - plateLinks
```
private List<Plate> plateLinks
```
  - annotationLinks
```
private List<Annotation> annotationLinks
```
- Constructor Detail
  - Screen
```
public Screen()
```
    Default constructor.
  - Screen
```
public Screen(Element element,
      OMEModel model)
       throws EnumerationException
```
    Constructs Screen 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.
  - Screen
```
public Screen(Screen orig)
```
    Copy constructor.
- Method Detail
  - update
```
public void update(Element element,
          OMEModel model)
            throws EnumerationException
```
    Updates Screen 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.
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getProtocolDescription
```
public String getProtocolDescription()
```
  - setProtocolDescription
```
public void setProtocolDescription(String protocolDescription)
```
  - getProtocolIdentifier
```
public String getProtocolIdentifier()
```
  - setProtocolIdentifier
```
public void setProtocolIdentifier(String protocolIdentifier)
```
  - getReagentSetDescription
```
public String getReagentSetDescription()
```
  - setReagentSetDescription
```
public void setReagentSetDescription(String reagentSetDescription)
```
  - getType
```
public String getType()
```
  - setType
```
public void setType(String type)
```
  - getID
```
public String getID()
```
  - setID
```
public void setID(String id)
```
  - getReagentSetIdentifier
```
public String getReagentSetIdentifier()
```
  - setReagentSetIdentifier
```
public void setReagentSetIdentifier(String reagentSetIdentifier)
```
  - getDescription
```
public String getDescription()
```
  - setDescription
```
public void setDescription(String description)
```
  - sizeOfReagentList
```
public int sizeOfReagentList()
```
  - copyReagentList
```
public List<Reagent> copyReagentList()
```
  - getReagent
```
public Reagent getReagent(int index)
```
  - setReagent
```
public Reagent setReagent(int index,
                 Reagent reagent)
```
  - addReagent
```
public void addReagent(Reagent reagent)
```
  - removeReagent
```
public void removeReagent(Reagent reagent)
```
  - sizeOfLinkedPlateList
```
public int sizeOfLinkedPlateList()
```
  - copyLinkedPlateList
```
public List<Plate> copyLinkedPlateList()
```
  - getLinkedPlate
```
public Plate getLinkedPlate(int index)
```
  - setLinkedPlate
```
public Plate setLinkedPlate(int index,
                   Plate o)
```
  - linkPlate
```
public boolean linkPlate(Plate o)
```
  - unlinkPlate
```
public boolean unlinkPlate(Plate 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)
```
  - 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 Screen_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.
    Screen_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 Screen

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

name

protocolDescription

protocolIdentifier

reagentSetDescription

type

id

reagentSetIdentifier

description

reagents

plateLinks

annotationLinks

Constructor Detail

Screen

Screen

Screen

Method Detail

update

link

getName

setName

getProtocolDescription

setProtocolDescription

getProtocolIdentifier

setProtocolIdentifier

getReagentSetDescription

setReagentSetDescription

getType

setType

getID

setID

getReagentSetIdentifier

setReagentSetIdentifier

getDescription

setDescription

sizeOfReagentList

copyReagentList

getReagent

setReagent

addReagent

removeReagent

sizeOfLinkedPlateList

copyLinkedPlateList

getLinkedPlate

setLinkedPlate

linkPlate

unlinkPlate

sizeOfLinkedAnnotationList

copyLinkedAnnotationList

getLinkedAnnotation

setLinkedAnnotation

linkAnnotation

unlinkAnnotation

asXMLElement

asXMLElement