ome.xml.model

Class Mask

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.Shape

ome.xml.model.Mask

All Implemented Interfaces:

OMEModelObject

public class Mask
extends Shape

Field Summary

Fields

Modifier and Type	Field and Description
private List<BinData>	binDataBlocks
private Double	height
private static org.slf4j.Logger	LOGGER Logger for this class.
static String	NAMESPACE
private Double	width
private Double	x
private Double	y

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addBinData(BinData binData)
Element	asXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.
protected Element	asXMLElement(Document document, Element Mask_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
List<BinData>	copyBinDataList()
BinData	getBinData(int index)
Double	getHeight()
Double	getWidth()
Double	getX()
Double	getY()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
void	removeBinData(BinData binData)
BinData	setBinData(int index, BinData binData)
void	setHeight(Double height)
void	setWidth(Double width)
void	setX(Double x)
void	setY(Double y)
int	sizeOfBinDataList()
void	update(Element element, OMEModel model) Updates Mask recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.Shape

copyLinkedAnnotationList, getFillColor, getFillRule, getFontFamily, getFontSize, getFontSizeUnitXsdDefault, getFontStyle, getID, getLineCap, getLinkedAnnotation, getLocked, getStrokeColor, getStrokeDashArray, getStrokeWidth, getStrokeWidthUnitXsdDefault, getText, getTheC, getTheT, getTheZ, getTransform, getUnion, getVisible, linkAnnotation, setFillColor, setFillRule, setFontFamily, setFontSize, setFontStyle, setID, setLineCap, setLinkedAnnotation, setLocked, setStrokeColor, setStrokeDashArray, setStrokeWidth, setText, setTheC, setTheT, setTheZ, setTransform, setUnion, setVisible, sizeOfLinkedAnnotationList, unlinkAnnotation

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.

y

private Double y

x

private Double x

height

private Double height

width

private Double width

binDataBlocks

private List<BinData> binDataBlocks

Constructor Detail

Mask

public Mask()

Default constructor.

Mask

public Mask(Element element,
    OMEModel model)
     throws EnumerationException

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

Mask

public Mask(Mask orig)

Copy constructor.

Method Detail

update

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

Updates Mask 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 Shape

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 Shape

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.

getY

public Double getY()

setY

public void setY(Double y)

getX

public Double getX()

setX

public void setX(Double x)

getHeight

public Double getHeight()

setHeight

public void setHeight(Double height)

getWidth

public Double getWidth()

setWidth

public void setWidth(Double width)

sizeOfBinDataList

public int sizeOfBinDataList()

copyBinDataList

public List<BinData> copyBinDataList()

getBinData

public BinData getBinData(int index)

setBinData

public BinData setBinData(int index,
                 BinData binData)

addBinData

public void addBinData(BinData binData)

removeBinData

public void removeBinData(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 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 Mask_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 Shape

Parameters:

document - Destination document for element creation, etc.

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

Returns:

element populated with properties from this class.