Version: Beta-4.1.1-r5927-b91

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.
list
listDirs
listFiles
listKnown
listKnownDirs
listKnownFiles
register
Create an OriginalFile in the database for the given path.
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.
pixels
render
thumbs
rename
delete
transfer

Operations

model::OriginalFile root() throws ServerError

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

api::StringSet list(string path) throws ServerError

api::StringSet listDirs(string path) throws ServerError

api::StringSet listFiles(string path) throws ServerError

api::OriginalFileList listKnown(string path) throws ServerError

api::OriginalFileList listKnownDirs(string path) throws ServerError

api::OriginalFileList listKnownFiles(string path) throws ServerError

model::OriginalFile register(string path, model::Format fmt) throws ServerError

Create an OriginalFile in the database for the given path. If the given path is already registered as an OriginalFile, a ValidationException is thrown. Otherwise, one is added and returned. TODO should this just return and not throw?

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::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


Home Previous Up Next Index