ome.xml.model

Class TiffData

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.TiffData

All Implemented Interfaces:

OMEModelObject

public class TiffData
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field and Description
private NonNegativeInteger	firstC
private NonNegativeInteger	firstT
private NonNegativeInteger	firstZ
private NonNegativeInteger	ifd
private static org.slf4j.Logger	LOGGER Logger for this class.
static String	NAMESPACE
private Pixels	pixels
private NonNegativeInteger	planeCount
private UUID	uuid

Constructor Summary

Constructors

Constructor and Description
TiffData() Default constructor.
TiffData(Element element, OMEModel model) Constructs TiffData recursively from an XML DOM tree.
TiffData(TiffData 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 TiffData_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
NonNegativeInteger	getFirstC()
NonNegativeInteger	getFirstT()
NonNegativeInteger	getFirstZ()
NonNegativeInteger	getIFD()
Pixels	getPixels()
NonNegativeInteger	getPlaneCount()
UUID	getUUID()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
void	setFirstC(NonNegativeInteger firstC)
void	setFirstT(NonNegativeInteger firstT)
void	setFirstZ(NonNegativeInteger firstZ)
void	setIFD(NonNegativeInteger ifd)
void	setPixels(Pixels pixels_BackReference)
void	setPlaneCount(NonNegativeInteger planeCount)
void	setUUID(UUID uuid)
void	update(Element element, OMEModel model) Updates TiffData 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.

ifd

private NonNegativeInteger ifd

planeCount

private NonNegativeInteger planeCount

firstZ

private NonNegativeInteger firstZ

firstC

private NonNegativeInteger firstC

firstT

private NonNegativeInteger firstT

uuid

private UUID uuid

pixels

private Pixels pixels

Constructor Detail

TiffData

public TiffData()

Default constructor.

TiffData

public TiffData(Element element,
        OMEModel model)
         throws EnumerationException

Constructs TiffData 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.

TiffData

public TiffData(TiffData orig)

Copy constructor.

Method Detail

update

public void update(Element element,
          OMEModel model)
            throws EnumerationException

Updates TiffData 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.

getIFD

public NonNegativeInteger getIFD()

setIFD

public void setIFD(NonNegativeInteger ifd)

getPlaneCount

public NonNegativeInteger getPlaneCount()

setPlaneCount

public void setPlaneCount(NonNegativeInteger planeCount)

getFirstZ

public NonNegativeInteger getFirstZ()

setFirstZ

public void setFirstZ(NonNegativeInteger firstZ)

getFirstC

public NonNegativeInteger getFirstC()

setFirstC

public void setFirstC(NonNegativeInteger firstC)

getFirstT

public NonNegativeInteger getFirstT()

setFirstT

public void setFirstT(NonNegativeInteger firstT)

getUUID

public UUID getUUID()

setUUID

public void setUUID(UUID uuid)

getPixels

public Pixels getPixels()

setPixels

public void setPixels(Pixels pixels_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 TiffData_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.

TiffData_element - Element from the subclass. If null a new element will be created of this class.

Returns:

element populated with properties from this class.