Package ome.model.annotations

Class XmlAnnotation

java.lang.Object

ome.model.annotations.Annotation

ome.model.annotations.TextAnnotation

ome.model.annotations.XmlAnnotation

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 XmlAnnotation
extends TextAnnotation
implements java.io.Serializable, IObject, IMutable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ome.model.annotations.Annotation

Annotation.Details

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EVENT_FILTER
static java.util.Set<java.lang.String>	FIELDS
static java.lang.String	GROUP_FILTER
static java.lang.String	OWNER_FILTER
static java.lang.String	PERMS_FILTER

Fields inherited from class ome.model.annotations.TextAnnotation

textValue, TEXTVALUE

Fields inherited from class ome.model.annotations.Annotation

_dynamicFields, _loaded, annotationLinks, ANNOTATIONLINKS, ANNOTATIONLINKSCOUNTPEROWNER, description, DESCRIPTION, details, DETAILS, EVENT_FILTER_ANNOTATIONLINKS, GROUP_FILTER_ANNOTATIONLINKS, id, ID, name, NAME, ns, NS, OWNER_FILTER_ANNOTATIONLINKS, PERMS_FILTER_ANNOTATIONLINKS, version, VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	acceptFilter(Filter __filter)
java.util.Set<java.lang.String>	fields()	returns a Set of field names that belong to this class
boolean	isValid()	calls the class-specific validator for this instance and returns the value from Validation.isValid()
XmlAnnotation	newInstance()
XmlAnnotation	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.
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.annotations.TextAnnotation

getTextValue, setTextValue

Methods inherited from class ome.model.annotations.Annotation

addAnnotationAnnotationLink, addAnnotationAnnotationLink, addAnnotationAnnotationLinkSet, clearAnnotationLinks, collectAnnotationLinks, eachLinkedAnnotation, errorIfUnloaded, findAnnotationAnnotationLink, getAnnotationLinks, getAnnotationLinksCountPerOwner, getDescription, getDetails, getGraphHolder, getId, getName, getNs, getVersion, isLoaded, iterateAnnotationLinks, linkAnnotation, linkedAnnotationIterator, linkedAnnotationList, removeAnnotationAnnotationLink, removeAnnotationAnnotationLink, removeAnnotationAnnotationLinkSet, setAnnotationLinks, setAnnotationLinksCountPerOwner, setDescription, setDetails, setId, setName, setNs, 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

FIELDS

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

Constructor Detail

XmlAnnotation

public XmlAnnotation()

XmlAnnotation

protected XmlAnnotation(java.lang.Long id)

XmlAnnotation

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

Main constructor.

Method Detail

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 TextAnnotation

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 TextAnnotation

Returns:

Validation collecting parameter.

newInstance

public XmlAnnotation newInstance()

proxy

public XmlAnnotation proxy()

acceptFilter

public boolean acceptFilter(Filter __filter)

Specified by:

acceptFilter in interface Filterable

Overrides:

acceptFilter in class TextAnnotation

toString

public java.lang.String toString()

Overrides:

toString in class TextAnnotation

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 TextAnnotation

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 TextAnnotation

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 TextAnnotation

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 TextAnnotation

throwNullCollectionException

protected void throwNullCollectionException(java.lang.String propertyName)

Overrides:

throwNullCollectionException in class TextAnnotation