ome.model.roi

Class Polyline

java.lang.Object

ome.model.roi.Shape

ome.model.roi.Polyline

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 Polyline
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
static String	EVENT_FILTER
static Set<String>	FIELDS
static String	GROUP_FILTER
protected String	markerEnd
static String	MARKEREND
protected String	markerStart
static String	MARKERSTART
static String	OWNER_FILTER
static String	PERMS_FILTER
protected String	points
static String	POINTS
protected String	textValue
static String	TEXTVALUE

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
	Polyline()
protected	Polyline(Long id)
	Polyline(Long id, boolean loaded) Main constructor.

Method Summary

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	getMarkerEnd() Simple field ome.model.roi.Polyline.markerEnd (java.lang.String)
String	getMarkerStart() Simple field ome.model.roi.Polyline.markerStart (java.lang.String)
String	getPoints() Simple field ome.model.roi.Polyline.points (java.lang.String)
String	getTextValue() Simple field ome.model.roi.Polyline.textValue (java.lang.String)
boolean	isValid() calls the class-specific validator for this instance and returns the value from Validation.isValid()
Polyline	newInstance()
Polyline	proxy()
void	putAt(String field, Object value) stores a value in this instance.
Object	retrieve(String field) retrieves a value from this instance.
void	setMarkerEnd(String markerEnd)
void	setMarkerStart(String markerStart)
void	setPoints(String points)
void	setTextValue(String textValue)
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, 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 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

points

protected String points

markerStart

protected String markerStart

markerEnd

protected String markerEnd

textValue

protected String textValue

POINTS

public static final String POINTS

See Also:

Constant Field Values

MARKERSTART

public static final String MARKERSTART

See Also:

Constant Field Values

MARKEREND

public static final String MARKEREND

See Also:

Constant Field Values

TEXTVALUE

public static final String TEXTVALUE

See Also:

Constant Field Values

FIELDS

public static final Set<String> FIELDS

Constructor Detail

Polyline

public Polyline()

Polyline

protected Polyline(Long id)

Polyline

public Polyline(Long id,
                boolean loaded)

Main constructor.

Method Detail

getPoints

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getPoints()

Simple field ome.model.roi.Polyline.points (java.lang.String)

setPoints

public void setPoints(String points)

getMarkerStart

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getMarkerStart()

Simple field ome.model.roi.Polyline.markerStart (java.lang.String)

setMarkerStart

public void setMarkerStart(String markerStart)

getMarkerEnd

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getMarkerEnd()

Simple field ome.model.roi.Polyline.markerEnd (java.lang.String)

setMarkerEnd

public void setMarkerEnd(String markerEnd)

getTextValue

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

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

setTextValue

public void setTextValue(String textValue)

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

proxy

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