Version: Beta-4.2.0-r7571-b29

OmeroBlitz Api
Home Previous Up Next Index

omero::grid::Repository

Overview

[ "ami" ] interface Repository

Client-accessible interface representing a single mount point on the server-side.

Operation Index

root
Return the OriginalFile descriptor for this Repository.
listFiles
listFileSets
mimetype
Returns the best-guess mimetype for the given path.
register
Create an OriginalFile in the database for the given path.
registerOriginalFile
Create an entry in the database for the given OriginalFile.
registerFileSet
Create entries in the database for the OriginalFile and Images in the imageList.
importFileSet
Import image metadata using the parent orginal file.
load
Load the OriginalFile at the given path with annotations and associated Pixels (if present).
read
Returns a special RawFileStore which permits only reading.
write
Returns a special RawFileStore which permits only writing.
file
pixels
render
thumbs
rename
delete
transfer
getThumbnail
Return the full path of a jpg thumbnail of the image file given in the path argument.
getThumbnailByIndex
Return the full path of a jpg thumbnail of the image at the imageIndex in the file set represented by the file given in the path argument.

Operations

model::OriginalFile root() throws ServerError

Return the OriginalFile descriptor for this Repository. It will have the path "/"

api::OriginalFileList listFiles(string path, RepositoryListConfig config) throws ServerError

FileSetList listFileSets(string path, RepositoryListConfig config) throws ServerError

string mimetype(string path) throws ServerError

Returns the best-guess mimetype for the given path.

model::OriginalFile register(string path, RString mimetype) throws ServerError

Create an OriginalFile in the database for the given path.

model::OriginalFile registerOriginalFile(model::OriginalFile omeroFile) throws ServerError

Create an entry in the database for the given OriginalFile. If the given OriginalFile is null a ValidationException is thrown. Otherwise, an entry is added and an unloaded IObject returned with id set.

api::IObjectList registerFileSet(model::OriginalFile keyFile, api::ImageList imageList) throws ServerError

Create entries in the database for the OriginalFile and Images in the imageList. If the given ImageList is null or empty the OriginalFile is registered only. If the OriginalFile is null a ValidationException is thrown. Otherwise, objects are added and list containing a loaded OriginalFile followed by the loaded Images is returned with ids set.

api::ImageList importFileSet(model::OriginalFile keyFile) throws ServerError

Import image metadata using the parent orginal file. If the id does not exist a ValidationException is thrown. Otherwise, the image set linked to that original file will have its metadata imported. The imported pixels list is returned.

model::OriginalFile load(string path) throws ServerError

Load the OriginalFile at the given path with annotations and associated Pixels (if present). If the path does not point to an OriginalFile, a ValidationException exception is thrown. TODO should this just return null instead?

api::RawFileStore* read(string path) throws ServerError

Returns a special RawFileStore which permits only reading. Any call to a write or configuration method will throw an ApiUsageException.

api::RawFileStore* write(string path) throws ServerError

Returns a special RawFileStore which permits only writing. Any call to a read or configuraiton method will throw an ApiUsageException. If a file exists at the given path, a ValidationException will be thrown. Once writing is complete, call close(), which will seal the file from all further writing. The SHA1 of the OriginalFile should be checked against the local value.

api::RawFileStore* file(long id) throws ServerError

api::RawPixelsStore* pixels(string path) throws ServerError

api::RenderingEngine* render(string path) throws ServerError

api::ThumbnailStore* thumbs(string path) throws ServerError

void rename(string path) throws ServerError

void delete(string path) throws ServerError

void transfer(string srcPath, Repository* target, string targetPath) throws ServerError

string getThumbnail(string path) throws ServerError

Return the full path of a jpg thumbnail of the image file given in the path argument.

string getThumbnailByIndex(string path, int imageIndex) throws ServerError

Return the full path of a jpg thumbnail of the image at the imageIndex in the file set represented by the file given in the path argument.


Home Previous Up Next Index