ome.model.roi

Class Mask

java.lang.Object

ome.model.roi.Shape

ome.model.roi.Mask

All Implemented Interfaces:

java.io.Serializable, IAnnotated, IMutable, IObject, Filterable

@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class Mask
extends Shape
implements java.io.Serializable, IObject, IMutable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ome.model.roi.Shape

Shape.Details

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	bytes
static java.lang.String	BYTES
static java.lang.String	EVENT_FILTER
static java.util.Set<java.lang.String>	FIELDS
static java.lang.String	GROUP_FILTER
protected java.lang.Double	height
static java.lang.String	HEIGHT
static java.lang.String	OWNER_FILTER
static java.lang.String	PERMS_FILTER
protected Pixels	pixels
static java.lang.String	PIXELS
protected java.lang.String	textValue
static java.lang.String	TEXTVALUE
protected java.lang.Double	width
static java.lang.String	WIDTH
protected java.lang.Double	x
static java.lang.String	X
protected java.lang.Double	y
static java.lang.String	Y

Fields inherited from class ome.model.roi.Shape

_dynamicFields, _loaded, annotationLinks, ANNOTATIONLINKS, ANNOTATIONLINKSCOUNTPEROWNER, details, DETAILS, EVENT_FILTER_ANNOTATIONLINKS, fillColor, FILLCOLOR, fillRule, FILLRULE, fontFamily, FONTFAMILY, fontSize, FONTSIZE, fontStyle, FONTSTYLE, GROUP_FILTER_ANNOTATIONLINKS, id, ID, locked, LOCKED, OWNER_FILTER_ANNOTATIONLINKS, PERMS_FILTER_ANNOTATIONLINKS, roi, ROI, strokeColor, STROKECOLOR, strokeDashArray, STROKEDASHARRAY, strokeWidth, STROKEWIDTH, theC, THEC, theT, THET, theZ, THEZ, transform, TRANSFORM, version, VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	Mask()
protected	Mask(java.lang.Long id)
	Mask(java.lang.Long id, boolean loaded) Main constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
java.util.Set<java.lang.String>	fields() returns a Set of field names that belong to this class
byte[]	getBytes() Simple field ome.model.roi.Mask.bytes (byte[])
java.lang.Double	getHeight() Simple field ome.model.roi.Mask.height (java.lang.Double)
Pixels	getPixels() Many-to-one field ome.model.roi.Mask.pixels (ome.model.core.Pixels)
java.lang.String	getTextValue() Simple field ome.model.roi.Mask.textValue (java.lang.String)
java.lang.Double	getWidth() Simple field ome.model.roi.Mask.width (java.lang.Double)
java.lang.Double	getX() Simple field ome.model.roi.Mask.x (java.lang.Double)
java.lang.Double	getY() Simple field ome.model.roi.Mask.y (java.lang.Double)
boolean	isValid() calls the class-specific validator for this instance and returns the value from Validation.isValid()
Mask	newInstance()
Mask	proxy()
void	putAt(java.lang.String field, java.lang.Object value) stores a value in this instance.
java.lang.Object	retrieve(java.lang.String field) retrieves a value from this instance.
void	setBytes(byte[] bytes)
void	setHeight(java.lang.Double height)
void	setPixels(Pixels pixels)
void	setTextValue(java.lang.String textValue)
void	setWidth(java.lang.Double width)
void	setX(java.lang.Double x)
void	setY(java.lang.Double y)
protected void	throwNullCollectionException(java.lang.String propertyName)
java.lang.String	toString()
void	unload() set the loaded field to false, and set all non-ID fields to null.
Validation	validate() calls the class-specific validator for this instance and returns the Validation object.

Methods inherited from class ome.model.roi.Shape

addShapeAnnotationLink, addShapeAnnotationLink, addShapeAnnotationLinkSet, clearAnnotationLinks, collectAnnotationLinks, eachLinkedAnnotation, errorIfUnloaded, findShapeAnnotationLink, getAnnotationLinks, getAnnotationLinksCountPerOwner, getDetails, getFillColor, getFillRule, getFontFamily, getFontSize, getFontStyle, getGraphHolder, getId, getLocked, getRoi, getStrokeColor, getStrokeDashArray, getStrokeWidth, getTheC, getTheT, getTheZ, getTransform, getVersion, isLoaded, iterateAnnotationLinks, linkAnnotation, linkedAnnotationIterator, linkedAnnotationList, removeShapeAnnotationLink, removeShapeAnnotationLink, removeShapeAnnotationLinkSet, setAnnotationLinks, setAnnotationLinksCountPerOwner, setDetails, setFillColor, setFillRule, setFontFamily, setFontSize, setFontStyle, setId, setLocked, setRoi, setStrokeColor, setStrokeDashArray, setStrokeWidth, setTheC, setTheT, setTheZ, setTransform, setVersion, sizeOfAnnotationLinks, unlinkAnnotation, unmodifiableAnnotationLinks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ome.model.IMutable

getVersion, setVersion

Methods inherited from interface ome.model.IObject

getDetails, getGraphHolder, getId, isLoaded, setId

Field Detail

OWNER_FILTER

public static final java.lang.String OWNER_FILTER

See Also:

Constant Field Values

GROUP_FILTER

public static final java.lang.String GROUP_FILTER

See Also:

Constant Field Values

EVENT_FILTER

public static final java.lang.String EVENT_FILTER

See Also:

Constant Field Values

PERMS_FILTER

public static final java.lang.String PERMS_FILTER

See Also:

Constant Field Values

x

protected java.lang.Double x

y

protected java.lang.Double y

width

protected java.lang.Double width

height

protected java.lang.Double height

pixels

protected Pixels pixels

textValue

protected java.lang.String textValue

bytes

protected byte[] bytes

X

public static final java.lang.String X

See Also:

Constant Field Values

Y

public static final java.lang.String Y

See Also:

Constant Field Values

WIDTH

public static final java.lang.String WIDTH

See Also:

Constant Field Values

HEIGHT

public static final java.lang.String HEIGHT

See Also:

Constant Field Values

PIXELS

public static final java.lang.String PIXELS

See Also:

Constant Field Values

TEXTVALUE

public static final java.lang.String TEXTVALUE

See Also:

Constant Field Values

BYTES

public static final java.lang.String BYTES

See Also:

Constant Field Values

FIELDS

public static final java.util.Set<java.lang.String> FIELDS

Constructor Detail

Mask

public Mask()

Mask

protected Mask(java.lang.Long id)

Mask

public Mask(java.lang.Long id,
            boolean loaded)

Main constructor.

Method Detail

getX

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Double getX()

Simple field ome.model.roi.Mask.x (java.lang.Double)

setX

public void setX(java.lang.Double x)

getY

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Double getY()

Simple field ome.model.roi.Mask.y (java.lang.Double)

setY

public void setY(java.lang.Double y)

getWidth

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Double getWidth()

Simple field ome.model.roi.Mask.width (java.lang.Double)

setWidth

public void setWidth(java.lang.Double width)

getHeight

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Double getHeight()

Simple field ome.model.roi.Mask.height (java.lang.Double)

setHeight

public void setHeight(java.lang.Double height)

getPixels

public Pixels getPixels()

Many-to-one field ome.model.roi.Mask.pixels (ome.model.core.Pixels)

setPixels

public void setPixels(Pixels pixels)

getTextValue

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public java.lang.String getTextValue()

Simple field ome.model.roi.Mask.textValue (java.lang.String)

setTextValue

public void setTextValue(java.lang.String textValue)

getBytes

public byte[] getBytes()

Simple field ome.model.roi.Mask.bytes (byte[])

setBytes

public void setBytes(byte[] bytes)

isValid

public boolean isValid()

Description copied from interface: IObject

calls the class-specific validator for this instance and returns the value from Validation.isValid()

Specified by:

isValid in interface IObject

Overrides:

isValid in class Shape

validate

public Validation validate()

Description copied from interface: IObject

calls the class-specific validator for this instance and returns the Validation object.

Specified by:

validate in interface IObject

Overrides:

validate in class Shape

Returns:

Validation collecting parameter.

newInstance

public Mask newInstance()

proxy

public Mask proxy()

acceptFilter

public boolean acceptFilter(Filter __filter)

Specified by:

acceptFilter in interface Filterable

Overrides:

acceptFilter in class Shape

toString

public java.lang.String toString()

Overrides:

toString in class Shape

fields

public java.util.Set<java.lang.String> fields()

Description copied from interface: IObject

returns a Set of field names that belong to this class

Specified by:

fields in interface IObject

Overrides:

fields in class Shape

retrieve

public java.lang.Object retrieve(java.lang.String field)

Description copied from interface: IObject

retrieves a value from this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be retrieved from a lazy-loaded map filled by calls to IObject.putAt(String, Object)

Specified by:

retrieve in interface IObject

Overrides:

retrieve in class Shape

putAt

public void putAt(java.lang.String field,
                  java.lang.Object value)

Description copied from interface: IObject

stores a value in this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be stored in a lazy-loaded map.

Specified by:

putAt in interface IObject

Overrides:

putAt in class Shape

Parameters:

field - Field name

value - Any object to be stored.

unload

public void unload()

Description copied from interface: IObject

set the loaded field to false, and set all non-ID fields to null. Subsequent calls to all accessors other than getId/setId will throw an ApiUsageException

Specified by:

unload in interface IObject

Overrides:

unload in class Shape

throwNullCollectionException

protected void throwNullCollectionException(java.lang.String propertyName)

Overrides:

throwNullCollectionException in class Shape