ome.model.annotations

Class FileAnnotation

java.lang.Object

ome.model.annotations.Annotation

ome.model.annotations.TypeAnnotation

ome.model.annotations.FileAnnotation

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 FileAnnotation
extends TypeAnnotation
implements 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 and Description
static String	EVENT_FILTER
static Set<String>	FIELDS
protected OriginalFile	file
static String	FILE
static String	GROUP_FILTER
static String	OWNER_FILTER
static String	PERMS_FILTER

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 and Description
	FileAnnotation()
protected	FileAnnotation(Long id)
	FileAnnotation(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
OriginalFile	getFile() Many-to-one field ome.model.annotations.FileAnnotation.file (ome.model.core.OriginalFile)
boolean	isValid() calls the class-specific validator for this instance and returns the value from Validation.isValid()
FileAnnotation	newInstance()
FileAnnotation	proxy()
void	putAt(String field, Object value) stores a value in this instance.
Object	retrieve(String field) retrieves a value from this instance.
void	setFile(OriginalFile file)
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.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 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

file

protected OriginalFile file

FILE

public static final String FILE

See Also:

Constant Field Values

FIELDS

public static final Set<String> FIELDS

Constructor Detail

FileAnnotation

public FileAnnotation()

FileAnnotation

protected FileAnnotation(Long id)

FileAnnotation

public FileAnnotation(Long id,
              boolean loaded)

Main constructor.

Method Detail

getFile

public OriginalFile getFile()

Many-to-one field ome.model.annotations.FileAnnotation.file (ome.model.core.OriginalFile)

setFile

public void setFile(OriginalFile file)

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 TypeAnnotation

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 TypeAnnotation

Returns:

Validation collecting parameter.

newInstance

public FileAnnotation newInstance()

proxy

public FileAnnotation proxy()

acceptFilter

public boolean acceptFilter(Filter __filter)

Specified by:

acceptFilter in interface Filterable

Overrides:

acceptFilter in class TypeAnnotation

toString

public String toString()

Overrides:

toString in class TypeAnnotation

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 TypeAnnotation

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 TypeAnnotation

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 TypeAnnotation

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 TypeAnnotation

throwNullCollectionException

protected void throwNullCollectionException(String propertyName)

Overrides:

throwNullCollectionException in class TypeAnnotation