Mask (OMERO API)

java.lang.Object
- ome.model.roi.Shape
- - ome.model.roi.Mask

All Implemented Interfaces:: 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 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 String`	`BYTES`
`static String`	`EVENT_FILTER`
`static Set<String>`	`FIELDS`
`static String`	`GROUP_FILTER`
`protected Double`	`height`
`static String`	`HEIGHT`
`static String`	`OWNER_FILTER`
`static String`	`PERMS_FILTER`
`protected Pixels`	`pixels`
`static String`	`PIXELS`
`protected String`	`textValue`
`static String`	`TEXTVALUE`
`protected Double`	`width`
`static String`	`WIDTH`
`protected Double`	`x`
`static String`	`X`
`protected Double`	`y`
`static 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, fontStretch, FONTSTRETCH, fontStyle, FONTSTYLE, fontVariant, FONTVARIANT, fontWeight, FONTWEIGHT, g, G, GROUP_FILTER_ANNOTATIONLINKS, id, ID, locked, LOCKED, OWNER_FILTER_ANNOTATIONLINKS, PERMS_FILTER_ANNOTATIONLINKS, roi, ROI, strokeColor, STROKECOLOR, strokeDashArray, STROKEDASHARRAY, strokeDashOffset, STROKEDASHOFFSET, strokeLineCap, STROKELINECAP, strokeLineJoin, STROKELINEJOIN, strokeMiterLimit, STROKEMITERLIMIT, strokeWidth, STROKEWIDTH, theC, THEC, theT, THET, theZ, THEZ, transform, TRANSFORM, vectorEffect, VECTOREFFECT, version, VERSION, visibility, VISIBILITY

Constructor Summary

Constructors
Modifier Constructor and Description

Mask()

protected Mask(Long id)

Mask(Long id, boolean loaded)
Main constructor.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter __filter)`
`Set<String>`	`fields()` returns a Set of field names that belong to this class
`byte[]`	`getBytes()` Simple field ome.model.roi.Mask.bytes (byte[])
`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)
`String`	`getTextValue()` Simple field ome.model.roi.Mask.textValue (java.lang.String)
`Double`	`getWidth()` Simple field ome.model.roi.Mask.width (java.lang.Double)
`Double`	`getX()` Simple field ome.model.roi.Mask.x (java.lang.Double)
`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(String field, Object value)` stores a value in this instance.
`Object`	`retrieve(String field)` retrieves a value from this instance.
`void`	`setBytes(byte[] bytes)`
`void`	`setHeight(Double height)`
`void`	`setPixels(Pixels pixels)`
`void`	`setTextValue(String textValue)`
`void`	`setWidth(Double width)`
`void`	`setX(Double x)`
`void`	`setY(Double y)`
`protected void`	`throwNullCollectionException(String propertyName)`
`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, getFontStretch, getFontStyle, getFontVariant, getFontWeight, getG, getGraphHolder, getId, getLocked, getRoi, getStrokeColor, getStrokeDashArray, getStrokeDashOffset, getStrokeLineCap, getStrokeLineJoin, getStrokeMiterLimit, getStrokeWidth, getTheC, getTheT, getTheZ, getTransform, getVectorEffect, getVersion, getVisibility, isLoaded, iterateAnnotationLinks, linkAnnotation, linkedAnnotationIterator, linkedAnnotationList, removeShapeAnnotationLink, removeShapeAnnotationLink, removeShapeAnnotationLinkSet, setAnnotationLinks, setAnnotationLinksCountPerOwner, setDetails, setFillColor, setFillRule, setFontFamily, setFontSize, setFontStretch, setFontStyle, setFontVariant, setFontWeight, setG, setId, setLocked, setRoi, setStrokeColor, setStrokeDashArray, setStrokeDashOffset, setStrokeLineCap, setStrokeLineJoin, setStrokeMiterLimit, setStrokeWidth, setTheC, setTheT, setTheZ, setTransform, setVectorEffect, setVersion, setVisibility, 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 String OWNER_FILTER
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER
```
public static final String GROUP_FILTER
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER
```
public static final String EVENT_FILTER
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER
```
public static final String PERMS_FILTER
```
    See Also:
    
    Constant Field Values
  - x
```
protected Double x
```
  - y
```
protected Double y
```
  - width
```
protected Double width
```
  - height
```
protected Double height
```
  - pixels
```
protected Pixels pixels
```
  - textValue
```
protected String textValue
```
  - bytes
```
protected byte[] bytes
```
  - X
```
public static final String X
```
    See Also:
    
    Constant Field Values
  - Y
```
public static final String Y
```
    See Also:
    
    Constant Field Values
  - WIDTH
```
public static final String WIDTH
```
    See Also:
    
    Constant Field Values
  - HEIGHT
```
public static final String HEIGHT
```
    See Also:
    
    Constant Field Values
  - PIXELS
```
public static final String PIXELS
```
    See Also:
    
    Constant Field Values
  - TEXTVALUE
```
public static final String TEXTVALUE
```
    See Also:
    
    Constant Field Values
  - BYTES
```
public static final String BYTES
```
    See Also:
    
    Constant Field Values
  - FIELDS
```
public static final Set<String> FIELDS
```
- Constructor Detail
  - Mask
```
public Mask()
```
  - Mask
```
protected Mask(Long id)
```
  - Mask
```
public Mask(Long id,
            boolean loaded)
```
    Main constructor.
- Method Detail
  - getX
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Double getX()
```
    Simple field ome.model.roi.Mask.x (java.lang.Double)
  - setX
```
public void setX(Double x)
```
  - getY
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Double getY()
```
    Simple field ome.model.roi.Mask.y (java.lang.Double)
  - setY
```
public void setY(Double y)
```
  - getWidth
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Double getWidth()
```
    Simple field ome.model.roi.Mask.width (java.lang.Double)
  - setWidth
```
public void setWidth(Double width)
```
  - getHeight
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Double getHeight()
```
    Simple field ome.model.roi.Mask.height (java.lang.Double)
  - setHeight
```
public void setHeight(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 String getTextValue()
```
    Simple field ome.model.roi.Mask.textValue (java.lang.String)
  - setTextValue
```
public void setTextValue(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 String toString()
```
    Overrides:
    
    toString in class Shape
  - fields
```
public Set<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 Object retrieve(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(String field,
                  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(String propertyName)
```
    Overrides:
    
    throwNullCollectionException in class Shape

Class Mask

Nested Class Summary

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

Field Summary

Fields inherited from class ome.model.roi.Shape

Constructor Summary

Method Summary

Methods inherited from class ome.model.roi.Shape

Methods inherited from class java.lang.Object

Methods inherited from interface ome.model.IMutable

Methods inherited from interface ome.model.IObject

Field Detail

OWNER_FILTER

GROUP_FILTER

EVENT_FILTER

PERMS_FILTER

x

y

width

height

pixels

textValue

bytes

X

Y

WIDTH

HEIGHT

PIXELS

TEXTVALUE

BYTES

FIELDS

Constructor Detail

Mask

Mask

Mask

Method Detail

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

getPixels

setPixels

getTextValue

setTextValue

getBytes

setBytes

isValid

validate

newInstance

proxy

acceptFilter

toString

fields

retrieve

putAt

unload

throwNullCollectionException