ome.api
Interface RawFileStore

All Superinterfaces:
ServiceInterface, StatefulServiceInterface
All Known Implementing Classes:
RawFileBean

public interface RawFileStore
extends StatefulServiceInterface

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

Since:
OMERO3.0
Version:
3.0 (Internal version: $Revision$ $Date: 2005/06/08 15:21:59 $)
Author:
Chris Allan      callan@blackcat.ca

Method Summary
 boolean exists()
          Checks to see if a raw file exists with the file ID that the service was initialized with.
 byte[] read(long position, int length)
          Delegates to FileBuffer
 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)
          Delegates to FileBuffer
 
Methods inherited from interface ome.api.StatefulServiceInterface
activate, close, getCurrentEventContext, passivate
 

Method Detail

setFileId

void setFileId(long fileId)
This method manages the state of the service.

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)
Delegates to FileBuffer

See Also:
FileBuffer.read(java.nio.ByteBuffer, long)

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().


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)
Delegates to FileBuffer

See Also:
FileBuffer.write(java.nio.ByteBuffer, long)

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


OmeroJava Api

Version: 4.3.3-00d1137e-b2894

Copyright © 2009 The University of Dundee. All Rights Reserved.