Package ome.xml.model

Class BinaryFile

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.BinaryFile

All Implemented Interfaces:

OMEModelObject

public class BinaryFile
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAMESPACE

Constructor Summary

Constructors

Constructor	Description
BinaryFile()	Default constructor.
BinaryFile(BinaryFile orig)	Copy constructor.
BinaryFile(org.w3c.dom.Element element, OMEModel model)	Constructs BinaryFile recursively from an XML DOM tree.

Method Summary

Modifier and Type	Method	Description
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document)	Takes the entire object hierarchy and produces an XML DOM tree.
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element BinaryFile_element)	Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
BinData	getBinData()
External	getExternal()
java.lang.String	getFileName()
java.lang.String	getMIMEType()
NonNegativeLong	getSize()
boolean	link(Reference reference, OMEModelObject o)	Link a given OME model object to this model object.
void	setBinData(BinData binData)
void	setExternal(External external)
void	setFileName(java.lang.String fileName)
void	setMIMEType(java.lang.String mimeType)
void	setSize(NonNegativeLong size)
void	update(org.w3c.dom.Element element, OMEModel model)	Updates BinaryFile 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 java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

BinaryFile

public BinaryFile()

Default constructor.

BinaryFile

public BinaryFile(org.w3c.dom.Element element,
                  OMEModel model)
           throws EnumerationException

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

BinaryFile

public BinaryFile(BinaryFile orig)

Copy constructor.

Method Detail

update

public void update(org.w3c.dom.Element element,
                   OMEModel model)
            throws EnumerationException

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

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

getSize

public NonNegativeLong getSize()

setSize

public void setSize(NonNegativeLong size)

getMIMEType

public java.lang.String getMIMEType()

setMIMEType

public void setMIMEType(java.lang.String mimeType)

getExternal

public External getExternal()

setExternal

public void setExternal(External external)

getBinData

public BinData getBinData()

setBinData

public void setBinData(BinData binData)

asXMLElement

public org.w3c.dom.Element asXMLElement(org.w3c.dom.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

public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document,
                                        org.w3c.dom.Element BinaryFile_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.

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

Returns:

element populated with properties from this class.