OriginalFile (OMERO API)

java.lang.Object
- ome.model.core.OriginalFile

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 OriginalFile
extends Object
implements Serializable, IObject, IMutable, IAnnotated
```
These filter definitions are used by the security system to eliminate non-readable objects from queries. The regular user does not need to worry about them, as they will be injected directly into the SQL (not HQL)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OriginalFile.Details

Nested Classes
Modifier and Type	Class and Description
`static class`	`OriginalFile.Details`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`_dynamicFields`
`protected boolean`	`_loaded`
`protected Set<OriginalFileAnnotationLink>`	`annotationLinks`
`static String`	`ANNOTATIONLINKS`
`static String`	`ANNOTATIONLINKSCOUNTPEROWNER`
`protected Timestamp`	`atime`
`static String`	`ATIME`
`protected Timestamp`	`ctime`
`static String`	`CTIME`
`protected Details`	`details`
`static String`	`DETAILS`
`static String`	`EVENT_FILTER`
`static String`	`EVENT_FILTER_ANNOTATIONLINKS`
`static String`	`EVENT_FILTER_FILESETENTRIES`
`static String`	`EVENT_FILTER_PIXELSFILEMAPS`
`static Set<String>`	`FIELDS`
`protected Set<FilesetEntry>`	`filesetEntries`
`static String`	`FILESETENTRIES`
`static String`	`GROUP_FILTER`
`static String`	`GROUP_FILTER_ANNOTATIONLINKS`
`static String`	`GROUP_FILTER_FILESETENTRIES`
`static String`	`GROUP_FILTER_PIXELSFILEMAPS`
`protected String`	`hash`
`static String`	`HASH`
`protected ChecksumAlgorithm`	`hasher`
`static String`	`HASHER`
`protected Long`	`id`
`static String`	`ID`
`protected String`	`mimetype`
`static String`	`MIMETYPE`
`protected Timestamp`	`mtime`
`static String`	`MTIME`
`protected String`	`name`
`static String`	`NAME`
`static String`	`OWNER_FILTER`
`static String`	`OWNER_FILTER_ANNOTATIONLINKS`
`static String`	`OWNER_FILTER_FILESETENTRIES`
`static String`	`OWNER_FILTER_PIXELSFILEMAPS`
`protected String`	`path`
`static String`	`PATH`
`static String`	`PERMS_FILTER`
`static String`	`PERMS_FILTER_ANNOTATIONLINKS`
`static String`	`PERMS_FILTER_FILESETENTRIES`
`static String`	`PERMS_FILTER_PIXELSFILEMAPS`
`protected Set<PixelsOriginalFileMap>`	`pixelsFileMaps`
`static String`	`PIXELSFILEMAPS`
`static String`	`PIXELSFILEMAPSCOUNTPEROWNER`
`protected Long`	`size`
`static String`	`SIZE`
`protected Integer`	`version`
`static String`	`VERSION`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`OriginalFile()`
`protected`	`OriginalFile(Long id)`
	`OriginalFile(Long id, boolean loaded)` Main constructor.
	`OriginalFile(String _path, String _name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter __filter)`
`void`	`addFilesetEntry(FilesetEntry target)` use instead of setFilesetEntries .
`void`	`addFilesetEntrySet(Collection<FilesetEntry> targets)` use like addFilesetEntry.
`void`	`addOriginalFileAnnotationLink(OriginalFileAnnotationLink target)` use instead of setAnnotationLinks .
`void`	`addOriginalFileAnnotationLink(OriginalFileAnnotationLink link, boolean bothSides)` Adds a ome.model.annotations.OriginalFileAnnotationLink to annotationLinks, allowing for recursion -- whether or not addOriginalFileAnnotationLink will be called on the addition if it is loaded
`void`	`addOriginalFileAnnotationLinkSet(Collection<OriginalFileAnnotationLink> targets)` use like addOriginalFileAnnotationLink.
`void`	`addPixelsOriginalFileMap(PixelsOriginalFileMap target)` use instead of setPixelsFileMaps .
`void`	`addPixelsOriginalFileMap(PixelsOriginalFileMap link, boolean bothSides)` Adds a ome.model.core.PixelsOriginalFileMap to pixelsFileMaps, allowing for recursion -- whether or not addPixelsOriginalFileMap will be called on the addition if it is loaded
`void`	`addPixelsOriginalFileMapSet(Collection<PixelsOriginalFileMap> targets)` use like addPixelsOriginalFileMap.
`void`	`clearAnnotationLinks()` clears the set.
`void`	`clearFilesetEntries()` clears the set.
`void`	`clearPixelsLinks()` clears the set.
`<E> List<E>`	`collectAnnotationLinks(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.annotations.OriginalFileAnnotationLink while collecting the results.
`<E> List<E>`	`collectFilesetEntries(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.fs.FilesetEntry while collecting the results.
`<E> List<E>`	`collectPixelsFileMaps(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.core.PixelsOriginalFileMap while collecting the results.
`<E> List<E>`	`eachLinkedAnnotation(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results.
`<E> List<E>`	`eachLinkedPixels(CBlock<E> block)` takes a CBlock and calls the block once for each ome.model.core.Pixels while collecting the results.
`protected void`	`errorIfUnloaded()`
`Set<String>`	`fields()` returns a Set of field names that belong to this class
`Set<OriginalFileAnnotationLink>`	`findOriginalFileAnnotationLink(Annotation target)` find all ome.model.annotations.OriginalFileAnnotationLink which have the argument as their child.
`Set<PixelsOriginalFileMap>`	`findPixelsOriginalFileMap(Pixels target)` find all ome.model.core.PixelsOriginalFileMap which have the argument as their child.
`protected Set<OriginalFileAnnotationLink>`	`getAnnotationLinks()` returns annotationLinks .
`Map<Long,Long>`	`getAnnotationLinksCountPerOwner()` If fetched, returns the count(*) of ome.model.annotations.OriginalFileAnnotationLink that a user has.
`Timestamp`	`getAtime()` Simple field ome.model.core.OriginalFile.atime (java.sql.Timestamp)
`Timestamp`	`getCtime()` Simple field ome.model.core.OriginalFile.ctime (java.sql.Timestamp)
`Details`	`getDetails()` The details of this object correspond to low-level system information.
`protected Set<FilesetEntry>`	`getFilesetEntries()` returns filesetEntries .
`GraphHolder`	`getGraphHolder()` retrieves the `GraphHolder` for this entity.
`String`	`getHash()` Simple field ome.model.core.OriginalFile.hash (java.lang.String)
`ChecksumAlgorithm`	`getHasher()` Many-to-one field ome.model.core.OriginalFile.hasher (ome.model.enums.ChecksumAlgorithm)
`Long`	`getId()` The DB unique identifier for this object.
`String`	`getMimetype()` Simple field ome.model.core.OriginalFile.mimetype (java.lang.String)
`Timestamp`	`getMtime()` Simple field ome.model.core.OriginalFile.mtime (java.sql.Timestamp)
`String`	`getName()` Simple field ome.model.core.OriginalFile.name (java.lang.String)
`String`	`getPath()` Simple field ome.model.core.OriginalFile.path (java.lang.String)
`protected Set<PixelsOriginalFileMap>`	`getPixelsFileMaps()` returns pixelsFileMaps .
`Map<Long,Long>`	`getPixelsFileMapsCountPerOwner()` If fetched, returns the count(*) of ome.model.core.PixelsOriginalFileMap that a user has.
`Long`	`getSize()` Simple field ome.model.core.OriginalFile.size (java.lang.Long)
`Integer`	`getVersion()` This version number is controlled by the database for optimisitic locking.
`boolean`	`isLoaded()` transient field (not stored in the DB) which specifies whether this object has been loaded from the DB or is only a wrapper around the ID.
`boolean`	`isValid()` calls the class-specific validator for this instance and returns the value from `Validation.isValid()`
`Iterator<OriginalFileAnnotationLink>`	`iterateAnnotationLinks()` should be used rather than accessing the annotationLinks set directly.
`Iterator<FilesetEntry>`	`iterateFilesetEntries()` should be used rather than accessing the filesetEntries set directly.
`Iterator<PixelsOriginalFileMap>`	`iteratePixelsFileMaps()` should be used rather than accessing the pixelsFileMaps set directly.
`OriginalFileAnnotationLink`	`linkAnnotation(Annotation addition)` Adds a ome.model.annotations.OriginalFileAnnotationLink to annotationLinks .
`Iterator<Annotation>`	`linkedAnnotationIterator()` provides an iterator over the parent values of the annotationLinks.
`List<Annotation>`	`linkedAnnotationList()` produces a `List`-copy of the underlying collection.
`Iterator<Pixels>`	`linkedPixelsIterator()` provides an iterator over the parent values of the pixelsFileMaps.
`List<Pixels>`	`linkedPixelsList()` produces a `List`-copy of the underlying collection.
`PixelsOriginalFileMap`	`linkPixels(Pixels addition)` Adds a ome.model.core.PixelsOriginalFileMap to pixelsFileMaps .
`OriginalFile`	`newInstance()`
`OriginalFile`	`proxy()`
`void`	`putAt(String field, Object value)` stores a value in this instance.
`void`	`removeFilesetEntry(FilesetEntry target)` removes a single element from this set and makes the inverse call on ome.model.fs.FilesetEntry
`void`	`removeFilesetEntrySet(Collection<FilesetEntry> targets)` use like removeFilesetEntry
`void`	`removeOriginalFileAnnotationLink(OriginalFileAnnotationLink target)` removes a single element from this set and makes the inverse call on ome.model.annotations.OriginalFileAnnotationLink
`void`	`removeOriginalFileAnnotationLink(OriginalFileAnnotationLink link, boolean bothSides)` removes the given OriginalFileAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkOriginalFile again if loaded.
`void`	`removeOriginalFileAnnotationLinkSet(Collection<OriginalFileAnnotationLink> targets)` use like removeOriginalFileAnnotationLink
`void`	`removePixelsOriginalFileMap(PixelsOriginalFileMap target)` removes a single element from this set and makes the inverse call on ome.model.core.PixelsOriginalFileMap
`void`	`removePixelsOriginalFileMap(PixelsOriginalFileMap link, boolean bothSides)` removes the given PixelsOriginalFileMap from pixelsFileMaps, allowing for recursion -- whether or not the removal will call unlinkOriginalFile again if loaded.
`void`	`removePixelsOriginalFileMapSet(Collection<PixelsOriginalFileMap> targets)` use like removePixelsOriginalFileMap
`Object`	`retrieve(String field)` retrieves a value from this instance.
`protected void`	`setAnnotationLinks(Set<OriginalFileAnnotationLink> annotationLinks)` setter for annotationLinks should be avoided.
`protected void`	`setAnnotationLinksCountPerOwner(Map<Long,Long> map)`
`void`	`setAtime(Timestamp atime)`
`void`	`setCtime(Timestamp ctime)`
`protected void`	`setDetails(Details details)` Use the `Details.copy(ome.model.internal.Details)` or `Details.shallowCopy(ome.model.internal.Details)` methods to set the `OriginalFile.Details` instance instead.
`protected void`	`setFilesetEntries(Set<FilesetEntry> filesetEntries)` setter for filesetEntries should be avoided.
`void`	`setHash(String hash)`
`void`	`setHasher(ChecksumAlgorithm hasher)`
`void`	`setId(Long id)` usually unneeded.
`void`	`setMimetype(String mimetype)`
`void`	`setMtime(Timestamp mtime)`
`void`	`setName(String name)`
`void`	`setPath(String path)`
`protected void`	`setPixelsFileMaps(Set<PixelsOriginalFileMap> pixelsFileMaps)` setter for pixelsFileMaps should be avoided.
`protected void`	`setPixelsFileMapsCountPerOwner(Map<Long,Long> map)`
`void`	`setSize(Long size)`
`void`	`setVersion(Integer version)` use with caution.
`int`	`sizeOfAnnotationLinks()` returns the size of annotationLinks.
`int`	`sizeOfFilesetEntries()` returns the size of filesetEntries.
`int`	`sizeOfPixelsFileMaps()` returns the size of pixelsFileMaps.
`protected void`	`throwNullCollectionException(String propertyName)`
`String`	`toString()`
`void`	`unlinkAnnotation(Annotation removal)` unlinks all ome.model.annotations.Annotation instances from this instance.
`void`	`unlinkPixels(Pixels removal)` unlinks all ome.model.core.Pixels instances from this instance.
`void`	`unload()` set the loaded field to false, and set all non-ID fields to null.
`Collection<OriginalFileAnnotationLink>`	`unmodifiableAnnotationLinks()` Returns an unmodifiable collection-view
`Collection<FilesetEntry>`	`unmodifiableFilesetEntries()` Returns an unmodifiable collection-view
`Collection<PixelsOriginalFileMap>`	`unmodifiablePixelsFileMaps()` Returns an unmodifiable collection-view
`Validation`	`validate()` calls the class-specific validator for this instance and returns the `Validation` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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
  - ID
```
public static final String ID
```
    See Also:
    
    Constant Field Values
  - id
```
protected Long id
```
  - VERSION
```
public static final String VERSION
```
    See Also:
    
    Constant Field Values
  - version
```
protected Integer version
```
  - pixelsFileMaps
```
protected Set<PixelsOriginalFileMap> pixelsFileMaps
```
  - OWNER_FILTER_PIXELSFILEMAPS
```
public static final String OWNER_FILTER_PIXELSFILEMAPS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_PIXELSFILEMAPS
```
public static final String GROUP_FILTER_PIXELSFILEMAPS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_PIXELSFILEMAPS
```
public static final String EVENT_FILTER_PIXELSFILEMAPS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_PIXELSFILEMAPS
```
public static final String PERMS_FILTER_PIXELSFILEMAPS
```
    See Also:
    
    Constant Field Values
  - path
```
protected String path
```
  - size
```
protected Long size
```
  - atime
```
protected Timestamp atime
```
  - mtime
```
protected Timestamp mtime
```
  - ctime
```
protected Timestamp ctime
```
  - hasher
```
protected ChecksumAlgorithm hasher
```
  - hash
```
protected String hash
```
  - mimetype
```
protected String mimetype
```
  - filesetEntries
```
protected Set<FilesetEntry> filesetEntries
```
  - OWNER_FILTER_FILESETENTRIES
```
public static final String OWNER_FILTER_FILESETENTRIES
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_FILESETENTRIES
```
public static final String GROUP_FILTER_FILESETENTRIES
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_FILESETENTRIES
```
public static final String EVENT_FILTER_FILESETENTRIES
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_FILESETENTRIES
```
public static final String PERMS_FILTER_FILESETENTRIES
```
    See Also:
    
    Constant Field Values
  - annotationLinks
```
protected Set<OriginalFileAnnotationLink> annotationLinks
```
  - OWNER_FILTER_ANNOTATIONLINKS
```
public static final String OWNER_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER_ANNOTATIONLINKS
```
public static final String GROUP_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER_ANNOTATIONLINKS
```
public static final String EVENT_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER_ANNOTATIONLINKS
```
public static final String PERMS_FILTER_ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - name
```
protected String name
```
  - details
```
protected Details details
```
  - PIXELSFILEMAPSCOUNTPEROWNER
```
public static final String PIXELSFILEMAPSCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - PIXELSFILEMAPS
```
public static final String PIXELSFILEMAPS
```
    See Also:
    
    Constant Field Values
  - PATH
```
public static final String PATH
```
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final String SIZE
```
    See Also:
    
    Constant Field Values
  - ATIME
```
public static final String ATIME
```
    See Also:
    
    Constant Field Values
  - MTIME
```
public static final String MTIME
```
    See Also:
    
    Constant Field Values
  - CTIME
```
public static final String CTIME
```
    See Also:
    
    Constant Field Values
  - HASHER
```
public static final String HASHER
```
    See Also:
    
    Constant Field Values
  - HASH
```
public static final String HASH
```
    See Also:
    
    Constant Field Values
  - MIMETYPE
```
public static final String MIMETYPE
```
    See Also:
    
    Constant Field Values
  - FILESETENTRIES
```
public static final String FILESETENTRIES
```
    See Also:
    
    Constant Field Values
  - ANNOTATIONLINKSCOUNTPEROWNER
```
public static final String ANNOTATIONLINKSCOUNTPEROWNER
```
    See Also:
    
    Constant Field Values
  - ANNOTATIONLINKS
```
public static final String ANNOTATIONLINKS
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - DETAILS
```
public static final String DETAILS
```
    See Also:
    
    Constant Field Values
  - FIELDS
```
public static final Set<String> FIELDS
```
  - _dynamicFields
```
protected Map<String,Object> _dynamicFields
```
  - _loaded
```
protected boolean _loaded
```
- Constructor Detail
  - OriginalFile
```
public OriginalFile()
```
  - OriginalFile
```
protected OriginalFile(Long id)
```
  - OriginalFile
```
public OriginalFile(Long id,
                    boolean loaded)
```
    Main constructor.
  - OriginalFile
```
public OriginalFile(String _path,
                    String _name)
```
- Method Detail
  - getId
```
@DocumentId
public Long getId()
```
    The DB unique identifier for this object. You are not responsible for setting the id; however, it can be useful for creating "unloaded" versions of your objects. Each top-level entity contains an id field of type long. For all objects returned from the server, this value will be non-null, which doesn't necessarily hold for the other fields.
    
    Specified by:
    
    getId in interface IObject
    
    Returns:
    
    Long primary key. May be null.
  - setId
```
public void setId(Long id)
```
    Description copied from interface: IObject
    
    usually unneeded. Ids are managed by the backend.
    
    Specified by:
    
    setId in interface IObject
    
    Parameters:
    
    id - Long value for this id.
  - getVersion
```
public Integer getVersion()
```
    This version number is controlled by the database for optimisitic locking.
    
    Specified by:
    
    getVersion in interface IMutable
  - setVersion
```
public void setVersion(Integer version)
```
    Description copied from interface: IMutable
    
    use with caution. In general, the version should only be altered by the backend. In the best case, an exception will be thrown for a version not equal to the current DB value. In the worst (though rare) case, the new version could match the database, and override optimistic lock checks that are supposed to prevent data loss.
    
    Specified by:
    
    setVersion in interface IMutable
    
    Parameters:
    
    version - Value for this objects version.
  - getPixelsFileMaps
```
protected Set<PixelsOriginalFileMap> getPixelsFileMaps()
```
    returns pixelsFileMaps . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.core.OriginalFile.pixelsFileMaps (ome.model.core.PixelsOriginalFileMap)
  - setPixelsFileMaps
```
protected void setPixelsFileMaps(Set<PixelsOriginalFileMap> pixelsFileMaps)
```
    setter for pixelsFileMaps should be avoided. Does not fulfill normal semantics.
  - sizeOfPixelsFileMaps
```
public int sizeOfPixelsFileMaps()
```
    returns the size of pixelsFileMaps. If less than zero, the Set was null.
  - iteratePixelsFileMaps
```
public Iterator<PixelsOriginalFileMap> iteratePixelsFileMaps()
```
    should be used rather than accessing the pixelsFileMaps set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfPixelsFileMaps() is less than zero.
  - unmodifiablePixelsFileMaps
```
public Collection<PixelsOriginalFileMap> unmodifiablePixelsFileMaps()
```
    Returns an unmodifiable collection-view
  - collectPixelsFileMaps
```
public <E> List<E> collectPixelsFileMaps(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.core.PixelsOriginalFileMap while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iteratePixelsFileMaps() internally and so will return a value even if the underlying collection is null.
  - addPixelsOriginalFileMap
```
public void addPixelsOriginalFileMap(PixelsOriginalFileMap target)
```
    use instead of setPixelsFileMaps . Makes the necessary call on ome.model.core.PixelsOriginalFileMap as well.
  - addPixelsOriginalFileMapSet
```
public void addPixelsOriginalFileMapSet(Collection<PixelsOriginalFileMap> targets)
```
    use like addPixelsOriginalFileMap.
  - removePixelsOriginalFileMap
```
public void removePixelsOriginalFileMap(PixelsOriginalFileMap target)
```
    removes a single element from this set and makes the inverse call on ome.model.core.PixelsOriginalFileMap
  - removePixelsOriginalFileMapSet
```
public void removePixelsOriginalFileMapSet(Collection<PixelsOriginalFileMap> targets)
```
    use like removePixelsOriginalFileMap
  - linkPixels
```
public PixelsOriginalFileMap linkPixels(Pixels addition)
```
    Adds a ome.model.core.PixelsOriginalFileMap to pixelsFileMaps . This entails changing our pixelsFileMaps Set, creating a new ome.model.core.PixelsOriginalFileMap and calling linkPixels on the ome.model.core.Pixels.
  - addPixelsOriginalFileMap
```
public void addPixelsOriginalFileMap(PixelsOriginalFileMap link,
                                     boolean bothSides)
```
    Adds a ome.model.core.PixelsOriginalFileMap to pixelsFileMaps, allowing for recursion -- whether or not addPixelsOriginalFileMap will be called on the addition if it is loaded
  - linkedPixelsIterator
```
public Iterator<Pixels> linkedPixelsIterator()
```
    provides an iterator over the parent values of the pixelsFileMaps. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedPixelsList() instead.
  - findPixelsOriginalFileMap
```
public Set<PixelsOriginalFileMap> findPixelsOriginalFileMap(Pixels target)
```
    find all ome.model.core.PixelsOriginalFileMap which have the argument as their child.
  - linkedPixelsList
```
public List<Pixels> linkedPixelsList()
```
    produces a List-copy of the underlying collection. Unlike, linkedPixelsIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
  - eachLinkedPixels
```
public <E> List<E> eachLinkedPixels(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.core.Pixels while collecting the results. If block == null, then the iterator values themselves are collected.
  - unlinkPixels
```
public void unlinkPixels(Pixels removal)
```
    unlinks all ome.model.core.Pixels instances from this instance.
  - removePixelsOriginalFileMap
```
public void removePixelsOriginalFileMap(PixelsOriginalFileMap link,
                                        boolean bothSides)
```
    removes the given PixelsOriginalFileMap from pixelsFileMaps, allowing for recursion -- whether or not the removal will call unlinkOriginalFile again if loaded.
  - clearPixelsLinks
```
public void clearPixelsLinks()
```
    clears the set.
  - setPixelsFileMapsCountPerOwner
```
protected void setPixelsFileMapsCountPerOwner(Map<Long,Long> map)
```
  - getPixelsFileMapsCountPerOwner
```
public Map<Long,Long> getPixelsFileMapsCountPerOwner()
```
    If fetched, returns the count(*) of ome.model.core.PixelsOriginalFileMap that a user has. If unfetched, returns null. No entries in the collection should be null.
  - getPath
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getPath()
```
    Simple field ome.model.core.OriginalFile.path (java.lang.String)
  - setPath
```
public void setPath(String path)
```
  - getSize
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Long getSize()
```
    Simple field ome.model.core.OriginalFile.size (java.lang.Long)
  - setSize
```
public void setSize(Long size)
```
  - getAtime
```
@DateBridge(resolution=MINUTE)
 @Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Timestamp getAtime()
```
    Simple field ome.model.core.OriginalFile.atime (java.sql.Timestamp)
  - setAtime
```
public void setAtime(Timestamp atime)
```
  - getMtime
```
@DateBridge(resolution=MINUTE)
 @Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Timestamp getMtime()
```
    Simple field ome.model.core.OriginalFile.mtime (java.sql.Timestamp)
  - setMtime
```
public void setMtime(Timestamp mtime)
```
  - getCtime
```
@DateBridge(resolution=MINUTE)
 @Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Timestamp getCtime()
```
    Simple field ome.model.core.OriginalFile.ctime (java.sql.Timestamp)
  - setCtime
```
public void setCtime(Timestamp ctime)
```
  - getHasher
```
public ChecksumAlgorithm getHasher()
```
    Many-to-one field ome.model.core.OriginalFile.hasher (ome.model.enums.ChecksumAlgorithm)
  - setHasher
```
public void setHasher(ChecksumAlgorithm hasher)
```
  - getHash
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getHash()
```
    Simple field ome.model.core.OriginalFile.hash (java.lang.String)
  - setHash
```
public void setHash(String hash)
```
  - getMimetype
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getMimetype()
```
    Simple field ome.model.core.OriginalFile.mimetype (java.lang.String)
  - setMimetype
```
public void setMimetype(String mimetype)
```
  - getFilesetEntries
```
protected Set<FilesetEntry> getFilesetEntries()
```
    returns filesetEntries . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.core.OriginalFile.filesetEntries (ome.model.fs.FilesetEntry)
  - setFilesetEntries
```
protected void setFilesetEntries(Set<FilesetEntry> filesetEntries)
```
    setter for filesetEntries should be avoided. Does not fulfill normal semantics.
  - sizeOfFilesetEntries
```
public int sizeOfFilesetEntries()
```
    returns the size of filesetEntries. If less than zero, the Set was null.
  - iterateFilesetEntries
```
public Iterator<FilesetEntry> iterateFilesetEntries()
```
    should be used rather than accessing the filesetEntries set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfFilesetEntries() is less than zero.
  - unmodifiableFilesetEntries
```
public Collection<FilesetEntry> unmodifiableFilesetEntries()
```
    Returns an unmodifiable collection-view
  - collectFilesetEntries
```
public <E> List<E> collectFilesetEntries(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.fs.FilesetEntry while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateFilesetEntries() internally and so will return a value even if the underlying collection is null.
  - addFilesetEntry
```
public void addFilesetEntry(FilesetEntry target)
```
    use instead of setFilesetEntries . Makes the necessary call on ome.model.fs.FilesetEntry as well.
  - addFilesetEntrySet
```
public void addFilesetEntrySet(Collection<FilesetEntry> targets)
```
    use like addFilesetEntry.
  - removeFilesetEntry
```
public void removeFilesetEntry(FilesetEntry target)
```
    removes a single element from this set and makes the inverse call on ome.model.fs.FilesetEntry
  - removeFilesetEntrySet
```
public void removeFilesetEntrySet(Collection<FilesetEntry> targets)
```
    use like removeFilesetEntry
  - clearFilesetEntries
```
public void clearFilesetEntries()
```
    clears the set.
  - getAnnotationLinks
```
protected Set<OriginalFileAnnotationLink> getAnnotationLinks()
```
    returns annotationLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.core.OriginalFile.annotationLinks (ome.model.annotations.OriginalFileAnnotationLink)
  - setAnnotationLinks
```
protected void setAnnotationLinks(Set<OriginalFileAnnotationLink> annotationLinks)
```
    setter for annotationLinks should be avoided. Does not fulfill normal semantics.
  - sizeOfAnnotationLinks
```
public int sizeOfAnnotationLinks()
```
    returns the size of annotationLinks. If less than zero, the Set was null.
    
    Specified by:
    
    sizeOfAnnotationLinks in interface IAnnotated
  - iterateAnnotationLinks
```
public Iterator<OriginalFileAnnotationLink> iterateAnnotationLinks()
```
    should be used rather than accessing the annotationLinks set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfAnnotationLinks() is less than zero.
    
    Specified by:
    
    iterateAnnotationLinks in interface IAnnotated
  - unmodifiableAnnotationLinks
```
public Collection<OriginalFileAnnotationLink> unmodifiableAnnotationLinks()
```
    Returns an unmodifiable collection-view
    
    Specified by:
    
    unmodifiableAnnotationLinks in interface IAnnotated
  - collectAnnotationLinks
```
public <E> List<E> collectAnnotationLinks(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.annotations.OriginalFileAnnotationLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateAnnotationLinks() internally and so will return a value even if the underlying collection is null.
    
    Specified by:
    
    collectAnnotationLinks in interface IAnnotated
  - addOriginalFileAnnotationLink
```
public void addOriginalFileAnnotationLink(OriginalFileAnnotationLink target)
```
    use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.OriginalFileAnnotationLink as well.
  - addOriginalFileAnnotationLinkSet
```
public void addOriginalFileAnnotationLinkSet(Collection<OriginalFileAnnotationLink> targets)
```
    use like addOriginalFileAnnotationLink.
  - removeOriginalFileAnnotationLink
```
public void removeOriginalFileAnnotationLink(OriginalFileAnnotationLink target)
```
    removes a single element from this set and makes the inverse call on ome.model.annotations.OriginalFileAnnotationLink
  - removeOriginalFileAnnotationLinkSet
```
public void removeOriginalFileAnnotationLinkSet(Collection<OriginalFileAnnotationLink> targets)
```
    use like removeOriginalFileAnnotationLink
  - linkAnnotation
```
public OriginalFileAnnotationLink linkAnnotation(Annotation addition)
```
    Adds a ome.model.annotations.OriginalFileAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.OriginalFileAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.
    
    Specified by:
    
    linkAnnotation in interface IAnnotated
  - addOriginalFileAnnotationLink
```
public void addOriginalFileAnnotationLink(OriginalFileAnnotationLink link,
                                          boolean bothSides)
```
    Adds a ome.model.annotations.OriginalFileAnnotationLink to annotationLinks, allowing for recursion -- whether or not addOriginalFileAnnotationLink will be called on the addition if it is loaded
  - linkedAnnotationIterator
```
public Iterator<Annotation> linkedAnnotationIterator()
```
    provides an iterator over the parent values of the annotationLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedAnnotationList() instead.
    
    Specified by:
    
    linkedAnnotationIterator in interface IAnnotated
  - findOriginalFileAnnotationLink
```
public Set<OriginalFileAnnotationLink> findOriginalFileAnnotationLink(Annotation target)
```
    find all ome.model.annotations.OriginalFileAnnotationLink which have the argument as their child.
  - linkedAnnotationList
```
public List<Annotation> linkedAnnotationList()
```
    produces a List-copy of the underlying collection. Unlike, linkedAnnotationIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.
    
    Specified by:
    
    linkedAnnotationList in interface IAnnotated
  - eachLinkedAnnotation
```
public <E> List<E> eachLinkedAnnotation(CBlock<E> block)
```
    takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results. If block == null, then the iterator values themselves are collected.
    
    Specified by:
    
    eachLinkedAnnotation in interface IAnnotated
  - unlinkAnnotation
```
public void unlinkAnnotation(Annotation removal)
```
    unlinks all ome.model.annotations.Annotation instances from this instance.
    
    Specified by:
    
    unlinkAnnotation in interface IAnnotated
  - removeOriginalFileAnnotationLink
```
public void removeOriginalFileAnnotationLink(OriginalFileAnnotationLink link,
                                             boolean bothSides)
```
    removes the given OriginalFileAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkOriginalFile again if loaded.
  - clearAnnotationLinks
```
public void clearAnnotationLinks()
```
    clears the set.
    
    Specified by:
    
    clearAnnotationLinks in interface IAnnotated
  - setAnnotationLinksCountPerOwner
```
protected void setAnnotationLinksCountPerOwner(Map<Long,Long> map)
```
  - getAnnotationLinksCountPerOwner
```
public Map<Long,Long> getAnnotationLinksCountPerOwner()
```
    If fetched, returns the count(*) of ome.model.annotations.OriginalFileAnnotationLink that a user has. If unfetched, returns null. No entries in the collection should be null.
  - getName
```
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getName()
```
    Simple field ome.model.core.OriginalFile.name (java.lang.String)
  - setName
```
public void setName(String name)
```
  - getDetails
```
public Details getDetails()
```
    The details of this object correspond to low-level system information. Owner, permissions, Details is always guaranteed to be non-null, unless the user actively nulls it. Every entity also contains a Detail reference, which doesn't refer to a separate table but rather to a collection of fields collected into a Hibernate "component" which is embedded in the object. HQL queries which refer to the Details component cannot directly fetch the entity like this: select o from Object join fetch o.details but rather each field of the Details instance must be explicitly joined: select o from Object join fetch o.details.owner It should also be noted that not all types have all the fields which are present on Details. For example, select e from Experimenter e join fetch e.details.owner will fail. Experimenter has no owner, for obvious reasons. Note: subclasses of this class will return a subclasse of the Details type.
    
    Specified by:
    
    getDetails in interface IObject
  - setDetails
```
protected void setDetails(Details details)
```
    Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the OriginalFile.Details instance instead.
  - 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
  - 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
    
    Returns:
    
    Validation collecting parameter.
  - newInstance
```
public OriginalFile newInstance()
```
  - proxy
```
public OriginalFile proxy()
```
  - acceptFilter
```
public boolean acceptFilter(Filter __filter)
```
    Specified by:
    
    acceptFilter in interface Filterable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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
  - 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
  - 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
    
    Parameters:
    
    field - Field name
    
    value - Any object to be stored.
  - isLoaded
```
public boolean isLoaded()
```
    Description copied from interface: IObject
    
    transient field (not stored in the DB) which specifies whether this object has been loaded from the DB or is only a wrapper around the ID.
    
    Specified by:
    
    isLoaded in interface IObject
  - errorIfUnloaded
```
protected void errorIfUnloaded()
```
  - 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
  - getGraphHolder
```
public final GraphHolder getGraphHolder()
```
    Description copied from interface: IObject
    
    retrieves the GraphHolder for this entity. If the GraphHolder has not been actively set, a new one will be instatiated.
    
    Specified by:
    
    getGraphHolder in interface IObject
    
    Returns:
    
    Non-null GraphHolder
  - throwNullCollectionException
```
protected void throwNullCollectionException(String propertyName)
```

Class OriginalFile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OWNER_FILTER

GROUP_FILTER

EVENT_FILTER

PERMS_FILTER

ID

id

VERSION

version

pixelsFileMaps

OWNER_FILTER_PIXELSFILEMAPS

GROUP_FILTER_PIXELSFILEMAPS

EVENT_FILTER_PIXELSFILEMAPS

PERMS_FILTER_PIXELSFILEMAPS

path

size

atime

mtime

ctime

hasher

hash

mimetype

filesetEntries

OWNER_FILTER_FILESETENTRIES

GROUP_FILTER_FILESETENTRIES

EVENT_FILTER_FILESETENTRIES

PERMS_FILTER_FILESETENTRIES

annotationLinks

OWNER_FILTER_ANNOTATIONLINKS

GROUP_FILTER_ANNOTATIONLINKS

EVENT_FILTER_ANNOTATIONLINKS

PERMS_FILTER_ANNOTATIONLINKS

name

details

PIXELSFILEMAPSCOUNTPEROWNER

PIXELSFILEMAPS

PATH

SIZE

ATIME

MTIME

CTIME

HASHER

HASH

MIMETYPE

FILESETENTRIES

ANNOTATIONLINKSCOUNTPEROWNER

ANNOTATIONLINKS

NAME

DETAILS

FIELDS

_dynamicFields

_loaded

Constructor Detail

OriginalFile

OriginalFile

OriginalFile

OriginalFile

Method Detail

getId

setId

getVersion

setVersion

getPixelsFileMaps

setPixelsFileMaps

sizeOfPixelsFileMaps

iteratePixelsFileMaps

unmodifiablePixelsFileMaps

collectPixelsFileMaps

addPixelsOriginalFileMap

addPixelsOriginalFileMapSet

removePixelsOriginalFileMap

removePixelsOriginalFileMapSet

linkPixels

addPixelsOriginalFileMap