Package ome.xml.model
Class OME
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.OME
- All Implemented Interfaces:
OMEModelObject
- Direct Known Subclasses:
OMEXMLMetadataRoot
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDataset(Dataset dataset) voidaddExperiment(Experiment experiment) voidaddExperimenter(Experimenter experimenter) voidaddExperimenterGroup(ExperimenterGroup experimenterGroup) voidvoidvoidaddInstrument(Instrument instrument) voidvoidaddProject(Project project) voidvoidasXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.asXMLElement(Document document, Element OME_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.voidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidgetDataset(int index) getExperiment(int index) getExperimenter(int index) getExperimenterGroup(int index) getFolder(int index) getImage(int index) getInstrument(int index) getPlate(int index) getProject(int index) getROI(int index) getScreen(int index) getUUID()booleanlink(Reference reference, OMEModelObject o) Link a given OME model object to this model object.voidremoveDataset(Dataset dataset) voidremoveExperiment(Experiment experiment) voidremoveExperimenter(Experimenter experimenter) voidremoveExperimenterGroup(ExperimenterGroup experimenterGroup) voidremoveFolder(Folder folder) voidremoveImage(Image image) voidremoveInstrument(Instrument instrument) voidremovePlate(Plate plate) voidremoveProject(Project project) voidvoidremoveScreen(Screen screen) voidsetBinaryOnly(BinaryOnly binaryOnly) voidsetCreator(String creator) setDataset(int index, Dataset dataset) setExperiment(int index, Experiment experiment) setExperimenter(int index, Experimenter experimenter) setExperimenterGroup(int index, ExperimenterGroup experimenterGroup) setInstrument(int index, Instrument instrument) setProject(int index, Project project) voidvoidsetStructuredAnnotations(StructuredAnnotations structuredAnnotations) voidintintintintintintintintintintintvoidUpdates OME recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
- See Also:
-
-
Constructor Details
-
OME
public OME()Default constructor. -
OME
Constructs OME 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.
-
OME
Copy constructor.
-
-
Method Details
-
update
Updates OME recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
updatein interfaceOMEModelObject- Overrides:
updatein 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
Description copied from interface:OMEModelObjectLink a given OME model object to this model object.- Specified by:
linkin interfaceOMEModelObject- Overrides:
linkin classAbstractOMEModelObject- Parameters:
reference- The type qualifier for the reference. This should be the corresponding reference type foro. If, for example,ois of typeImage,referenceMUST be of typeImageRef.o- Model object to link to.- Returns:
trueif this model object was able to handle the reference,falseotherwise.
-
getUUID
-
setUUID
-
getCreator
-
setCreator
-
getRights
-
setRights
-
sizeOfProjectList
public int sizeOfProjectList() -
copyProjectList
-
clearProjectList
public void clearProjectList() -
getProject
-
setProject
-
addProject
-
removeProject
-
sizeOfDatasetList
public int sizeOfDatasetList() -
copyDatasetList
-
clearDatasetList
public void clearDatasetList() -
getDataset
-
setDataset
-
addDataset
-
removeDataset
-
sizeOfFolderList
public int sizeOfFolderList() -
copyFolderList
-
clearFolderList
public void clearFolderList() -
getFolder
-
setFolder
-
addFolder
-
removeFolder
-
sizeOfExperimentList
public int sizeOfExperimentList() -
copyExperimentList
-
clearExperimentList
public void clearExperimentList() -
getExperiment
-
setExperiment
-
addExperiment
-
removeExperiment
-
sizeOfPlateList
public int sizeOfPlateList() -
copyPlateList
-
clearPlateList
public void clearPlateList() -
getPlate
-
setPlate
-
addPlate
-
removePlate
-
sizeOfScreenList
public int sizeOfScreenList() -
copyScreenList
-
clearScreenList
public void clearScreenList() -
getScreen
-
setScreen
-
addScreen
-
removeScreen
-
sizeOfExperimenterList
public int sizeOfExperimenterList() -
copyExperimenterList
-
clearExperimenterList
public void clearExperimenterList() -
getExperimenter
-
setExperimenter
-
addExperimenter
-
removeExperimenter
-
sizeOfExperimenterGroupList
public int sizeOfExperimenterGroupList() -
copyExperimenterGroupList
-
clearExperimenterGroupList
public void clearExperimenterGroupList() -
getExperimenterGroup
-
setExperimenterGroup
-
addExperimenterGroup
-
removeExperimenterGroup
-
sizeOfInstrumentList
public int sizeOfInstrumentList() -
copyInstrumentList
-
clearInstrumentList
public void clearInstrumentList() -
getInstrument
-
setInstrument
-
addInstrument
-
removeInstrument
-
sizeOfImageList
public int sizeOfImageList() -
copyImageList
-
clearImageList
public void clearImageList() -
getImage
-
setImage
-
addImage
-
removeImage
-
getStructuredAnnotations
-
setStructuredAnnotations
-
sizeOfROIList
public int sizeOfROIList() -
copyROIList
-
clearROIList
public void clearROIList() -
getROI
-
setROI
-
addROI
-
removeROI
-
getBinaryOnly
-
setBinaryOnly
-
asXMLElement
Description copied from interface:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Specified by:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
Description copied from class:AbstractOMEModelObjectTakes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.- Overrides:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.OME_element- Element from the subclass. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-