Package fr.igred.omero.annotations

Interface FileAnnotation

All Superinterfaces:

Annotation, ContainerLinked, HCSLinked, ImageLinked, RemoteObject

All Known Implementing Classes:

FileAnnotationWrapper

public interface FileAnnotation
extends Annotation

Interface to handle File Annotations on OMERO.

Method Summary

Modifier and Type	Method	Description
FileAnnotationData	asDataObject()	Returns an FileAnnotationData corresponding to the handled object.
java.io.File	getAttachedFile()	Returns the file to upload to the server.
java.lang.String	getContentAsString()	Returns the absolute path to the file
java.io.File	getFile(ConnectionHandler client, java.lang.String path)	Returns the original file.
java.lang.String	getFileFormat()	Returns the format of the uploaded file.
long	getFileID()	Returns the ID of the file.
java.lang.String	getFileKind()	Returns a user readable description of the file.
java.lang.String	getFileName()	Returns the name of the file.
java.lang.String	getFilePath()	Returns the absolute path to the file.
long	getFileSize()	Returns the size of the file.
java.lang.String	getOriginalMimetype()	Returns the format of the original file.
java.lang.String	getServerFileMimetype()	Returns the file format as defined by the specification, corresponding to the file extension.
boolean	isMovieFile()	Returns true if it is a movie file.

Methods inherited from interface fr.igred.omero.annotations.Annotation

countAnnotationLinks, getDescription, getFolders, getLastModified, getNameSpace, setDescription, setNameSpace

Methods inherited from interface fr.igred.omero.ContainerLinked

getDatasets, getProjects

Methods inherited from interface fr.igred.omero.HCSLinked

getPlateAcquisitions, getPlates, getScreens, getWells

Methods inherited from interface fr.igred.omero.ImageLinked

getImages

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getGroupId, getId, getOwner, saveAndUpdate

Method Detail

asDataObject

FileAnnotationData asDataObject()

Returns an FileAnnotationData corresponding to the handled object.

Specified by:

asDataObject in interface Annotation

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

getOriginalMimetype

java.lang.String getOriginalMimetype()

Returns the format of the original file.

Returns:

See above.

getServerFileMimetype

java.lang.String getServerFileMimetype()

Returns the file format as defined by the specification, corresponding to the file extension.

Returns:

See above.

getFileFormat

java.lang.String getFileFormat()

Returns the format of the uploaded file.

Returns:

See above.

getFileKind

java.lang.String getFileKind()

Returns a user readable description of the file.

Returns:

See above.

getAttachedFile

java.io.File getAttachedFile()

Returns the file to upload to the server.

Returns:

See above.

getFileName

java.lang.String getFileName()

Returns the name of the file.

Returns:

See above.

getFilePath

java.lang.String getFilePath()

Returns the absolute path to the file.

Returns:

See above.

getFileSize

long getFileSize()

Returns the size of the file.

Returns:

See above.

getFileID

long getFileID()

Returns the ID of the file.

Returns:

See above.

getFile

java.io.File getFile(ConnectionHandler client,
                     java.lang.String path)
              throws java.io.IOException,
                     ServiceException,
                     ServerException

Returns the original file.

Parameters:

client - The client handling the connection.

path - The path where the file will be saved.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

java.io.IOException - Cannot write to the file.

ServerException - Server error.

getContentAsString

java.lang.String getContentAsString()

Returns the absolute path to the file

Returns:

See above.

See Also:

FileAnnotationData.getContentAsString()

isMovieFile

boolean isMovieFile()

Returns true if it is a movie file. false otherwise.

Returns:

See above.