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
-
-
Constructor Summary
Constructors Constructor Description BinaryFile()
Default constructor.BinaryFile(BinaryFile orig)
Copy constructor.BinaryFile(Element element, OMEModel model)
Constructs BinaryFile recursively from an XML DOM tree.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Element
asXMLElement(Document document)
Takes the entire object hierarchy and produces an XML DOM tree.Element
asXMLElement(Document document, Element BinaryFile_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.BinData
getBinData()
External
getExternal()
String
getFileName()
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(String fileName)
void
setMIMEType(String mimeType)
void
setSize(NonNegativeLong size)
void
update(Element element, OMEModel model)
Updates BinaryFile recursively from an XML DOM tree.-
Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
-
-
-
Field Detail
-
NAMESPACE
public static final String NAMESPACE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BinaryFile
public BinaryFile()
Default constructor.
-
BinaryFile
public BinaryFile(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(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 interfaceOMEModelObject
- Overrides:
update
in classAbstractOMEModelObject
- 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 interfaceOMEModelObject
- Overrides:
link
in classAbstractOMEModelObject
- Parameters:
reference
- The type qualifier for the reference. This should be the corresponding reference type foro
. If, for example,o
is of typeImage
,reference
MUST be of typeImageRef
.o
- Model object to link to.- Returns:
true
if this model object was able to handle the reference,false
otherwise.
-
getFileName
public String getFileName()
-
setFileName
public void setFileName(String fileName)
-
getSize
public NonNegativeLong getSize()
-
setSize
public void setSize(NonNegativeLong size)
-
getMIMEType
public String getMIMEType()
-
setMIMEType
public void setMIMEType(String mimeType)
-
getExternal
public External getExternal()
-
setExternal
public void setExternal(External external)
-
getBinData
public BinData getBinData()
-
setBinData
public void setBinData(BinData binData)
-
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 interfaceOMEModelObject
- Specified by:
asXMLElement
in classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
public Element asXMLElement(Document document, 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 classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.BinaryFile_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-
-