ome.api

Interface RawFileStore

All Superinterfaces:

ServiceInterface, StatefulServiceInterface

public interface RawFileStore
extends StatefulServiceInterface

Raw file gateway which provides access to the OMERO file repository.

Since:

OMERO3.0

Method Summary

Modifier and Type	Method and Description
boolean	exists() Checks to see if a raw file exists with the file ID that the service was initialized with.
java.lang.Long	getFileId() Returns the current file id or null if none has been set.
byte[]	read(long position, int length) Reads length bytes of data at the position from the raw file into an array of bytes
ome.model.core.OriginalFile	save() Saves the OriginalFile associated with the service if it has been modified.
void	setFileId(long fileId) This method manages the state of the service.
long	size() Returns the size of the file on disk (not as stored in the database since that value will only be updated on save().
boolean	truncate(long length) Limits the size of a file to the given length.
void	write(byte[] buf, long position, int length) Writes length bytes of data from the specified buf byte array starting at at position to the raw file

Methods inherited from interface ome.api.StatefulServiceInterface

activate, close, getCurrentEventContext, passivate

Method Detail

getFileId

java.lang.Long getFileId()

Returns the current file id or null if none has been set.

setFileId

void setFileId(long fileId)

This method manages the state of the service. If the given file is not considered DOWNLOADABLE, this method will throw a SecurityViolation.

Parameters:

fileId - an OriginalFile id.

exists

boolean exists()

Checks to see if a raw file exists with the file ID that the service was initialized with.

Returns:

true if there is an accessible file within the original file repository with the correct ID. Otherwise false.

Throws:

ome.conditions.ResourceError - if there is a problem accessing the file due to permissions errors within the repository or any other I/O error.

read

byte[] read(long position,
            int length)

Reads length bytes of data at the position from the raw file into an array of bytes

size

long size()

Returns the size of the file on disk (not as stored in the database since that value will only be updated on save(). If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.

truncate

boolean truncate(long length)

Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.

write

void write(byte[] buf,
           long position,
           int length)

Writes length bytes of data from the specified buf byte array starting at at position to the raw file

save

ome.model.core.OriginalFile save()

Saves the OriginalFile associated with the service if it has been modified. The returned valued should replace all instances of the OriginalFile in the client. If save has not been called, RawFileStore instances will save the OriginalFile object associated with it on StatefulServiceInterface.close().

See Also:

2161