ome.model.roi

Class Label

java.lang.Object

ome.model.roi.Shape

ome.model.roi.Label

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 Label
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 String	anchor
static String	ANCHOR
protected String	baselineShift
static String	BASELINESHIFT
protected String	decoration
static String	DECORATION
protected String	direction
static String	DIRECTION
static String	EVENT_FILTER
static Set<String>	FIELDS
protected Integer	glyphOrientationVertical
static String	GLYPHORIENTATIONVERTICAL
static String	GROUP_FILTER
static String	OWNER_FILTER
static String	PERMS_FILTER
protected String	textValue
static String	TEXTVALUE
protected String	writingMode
static String	WRITINGMODE
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
	Label()
protected	Label(Long id)
	Label(Long id, boolean loaded) Main constructor.

Method Summary

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
String	getAnchor() Simple field ome.model.roi.Label.anchor (java.lang.String)
String	getBaselineShift() Simple field ome.model.roi.Label.baselineShift (java.lang.String)
String	getDecoration() Simple field ome.model.roi.Label.decoration (java.lang.String)
String	getDirection() Simple field ome.model.roi.Label.direction (java.lang.String)
Integer	getGlyphOrientationVertical() Simple field ome.model.roi.Label.glyphOrientationVertical (java.lang.Integer)
String	getTextValue() Simple field ome.model.roi.Label.textValue (java.lang.String)
String	getWritingMode() Simple field ome.model.roi.Label.writingMode (java.lang.String)
Double	getX() Simple field ome.model.roi.Label.x (java.lang.Double)
Double	getY() Simple field ome.model.roi.Label.y (java.lang.Double)
boolean	isValid() calls the class-specific validator for this instance and returns the value from Validation.isValid()
Label	newInstance()
Label	proxy()
void	putAt(String field, Object value) stores a value in this instance.
Object	retrieve(String field) retrieves a value from this instance.
void	setAnchor(String anchor)
void	setBaselineShift(String baselineShift)
void	setDecoration(String decoration)
void	setDirection(String direction)
void	setGlyphOrientationVertical(Integer glyphOrientationVertical)
void	setTextValue(String textValue)
void	setWritingMode(String writingMode)
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

textValue

protected String textValue

anchor

protected String anchor

decoration

protected String decoration

baselineShift

protected String baselineShift

glyphOrientationVertical

protected Integer glyphOrientationVertical

direction

protected String direction

writingMode

protected String writingMode

X

public static final String X

See Also:

Constant Field Values

Y

public static final String Y

See Also:

Constant Field Values

TEXTVALUE

public static final String TEXTVALUE

See Also:

Constant Field Values

ANCHOR

public static final String ANCHOR

See Also:

Constant Field Values

DECORATION

public static final String DECORATION

See Also:

Constant Field Values

BASELINESHIFT

public static final String BASELINESHIFT

See Also:

Constant Field Values

GLYPHORIENTATIONVERTICAL

public static final String GLYPHORIENTATIONVERTICAL

See Also:

Constant Field Values

DIRECTION

public static final String DIRECTION

See Also:

Constant Field Values

WRITINGMODE

public static final String WRITINGMODE

See Also:

Constant Field Values

FIELDS

public static final Set<String> FIELDS

Constructor Detail

Label

public Label()

Label

protected Label(Long id)

Label

public Label(Long id,
     boolean loaded)

Main constructor.

Method Detail

getX

@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")})
public Double getX()

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

setX

public void setX(Double x)

getY

@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")})
public Double getY()

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

setY

public void setY(Double y)

getTextValue

@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")})
public String getTextValue()

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

setTextValue

public void setTextValue(String textValue)

getAnchor

@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")})
public String getAnchor()

Simple field ome.model.roi.Label.anchor (java.lang.String)

setAnchor

public void setAnchor(String anchor)

getDecoration

@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")})
public String getDecoration()

Simple field ome.model.roi.Label.decoration (java.lang.String)

setDecoration

public void setDecoration(String decoration)

getBaselineShift

@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")})
public String getBaselineShift()

Simple field ome.model.roi.Label.baselineShift (java.lang.String)

setBaselineShift

public void setBaselineShift(String baselineShift)

getGlyphOrientationVertical

@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")})
public Integer getGlyphOrientationVertical()

Simple field ome.model.roi.Label.glyphOrientationVertical (java.lang.Integer)

setGlyphOrientationVertical

public void setGlyphOrientationVertical(Integer glyphOrientationVertical)

getDirection

@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")})
public String getDirection()

Simple field ome.model.roi.Label.direction (java.lang.String)

setDirection

public void setDirection(String direction)

getWritingMode

@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")})
public String getWritingMode()

Simple field ome.model.roi.Label.writingMode (java.lang.String)

setWritingMode

public void setWritingMode(String writingMode)

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 Label newInstance()

proxy

public Label 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