ome.xml.model

Class BinData

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.BinData

All Implemented Interfaces:

OMEModelObject

public class BinData
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field and Description
private Boolean	bigEndian
private Compression	compression
private NonNegativeLong	length
private static org.slf4j.Logger	LOGGER Logger for this class.
private Mask	mask
static String	NAMESPACE
private Pixels	pixels

Constructor Summary

Constructors

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

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 BinData_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
Boolean	getBigEndian()
Compression	getCompression()
NonNegativeLong	getLength()
Mask	getMask()
Pixels	getPixels()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
void	setBigEndian(Boolean bigEndian)
void	setCompression(Compression compression)
void	setLength(NonNegativeLong length)
void	setMask(Mask mask_BackReference)
void	setPixels(Pixels pixels_BackReference)
void	update(Element element, OMEModel model) Updates BinData 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.

bigEndian

private Boolean bigEndian

length

private NonNegativeLong length

compression

private Compression compression

pixels

private Pixels pixels

mask

private Mask mask

Constructor Detail

BinData

public BinData()

Default constructor.

BinData

public BinData(Element element,
       OMEModel model)
        throws EnumerationException

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

BinData

public BinData(BinData orig)

Copy constructor.

Method Detail

update

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

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

getBigEndian

public Boolean getBigEndian()

setBigEndian

public void setBigEndian(Boolean bigEndian)

getLength

public NonNegativeLong getLength()

setLength

public void setLength(NonNegativeLong length)

getCompression

public Compression getCompression()

setCompression

public void setCompression(Compression compression)

getPixels

public Pixels getPixels()

setPixels

public void setPixels(Pixels pixels_BackReference)

getMask

public Mask getMask()

setMask

public void setMask(Mask mask_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 BinData_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.

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

Returns:

element populated with properties from this class.