Package fr.igred.omero.annotations

Class FileAnnotationWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<T>

fr.igred.omero.annotations.GenericAnnotationWrapper<FileAnnotationData>

fr.igred.omero.annotations.FileAnnotationWrapper

public class FileAnnotationWrapper
extends GenericAnnotationWrapper<FileAnnotationData>

Class containing a FileAnnotationData object.

Wraps function calls to the FileAnnotationData contained.

Field Summary

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
FileAnnotationWrapper(FileAnnotationData annotation)	Constructor of the GenericAnnotationWrapper class.

Method Summary

Modifier and Type	Method	Description
FileAnnotationData	asFileAnnotationData()	Gets the FileAnnotationData contained.
File	getAttachedFile()	Returns the file to upload to the server.
String	getContentAsString()	Returns the absolute path to the file
File	getFile(Client client, String path)	Returns the original file.
String	getFileFormat()	Returns the format of the uploaded file.
long	getFileID()	Returns the id of the file.
String	getFileKind()	Returns a user readable description of the file.
String	getFileName()	Returns the name of the file.
String	getFilePath()	Returns the absolute path to the file.
long	getFileSize()	Returns the size of the file.
String	getOriginalMimetype()	Returns the format of the original file.
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 class fr.igred.omero.annotations.GenericAnnotationWrapper

countAnnotationLinks, getDatasets, getDescription, getImages, getLastModified, getNameSpace, getPlates, getProjects, getScreens, getWells, setDescription, setNameSpace

Methods inherited from class fr.igred.omero.GenericObjectWrapper

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, delete, distinct, getCreated, getGroupId, getId, getOwner, saveAndUpdate, toString, wrap, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FileAnnotationWrapper

public FileAnnotationWrapper(FileAnnotationData annotation)

Constructor of the GenericAnnotationWrapper class.

Parameters:

annotation - Annotation to be contained.

Method Detail

getOriginalMimetype

public String getOriginalMimetype()

Returns the format of the original file.

Returns:

See above.

getServerFileMimetype

public String getServerFileMimetype()

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

Returns:

See above.

getFileFormat

public String getFileFormat()

Returns the format of the uploaded file.

Returns:

See above.

getFileKind

public String getFileKind()

Returns a user readable description of the file.

Returns:

See above.

getAttachedFile

public File getAttachedFile()

Returns the file to upload to the server.

Returns:

See above.

getFileName

public String getFileName()

Returns the name of the file.

Returns:

See above.

getFilePath

public String getFilePath()

Returns the absolute path to the file.

Returns:

See above.

getFileSize

public long getFileSize()

Returns the size of the file.

Returns:

See above.

getFileID

public long getFileID()

Returns the id of the file.

Returns:

See above.

getFile

public File getFile(Client client,
                    String path)
             throws IOException,
                    ServiceException,
                    OMEROServerError

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.

IOException - Cannot write to the file.

OMEROServerError - Server error.

getContentAsString

public String getContentAsString()

Returns the absolute path to the file

Returns:

See above.

See Also:

AnnotationData.getContentAsString()

isMovieFile

public boolean isMovieFile()

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

Returns:

See above.

asFileAnnotationData

public FileAnnotationData asFileAnnotationData()

Gets the FileAnnotationData contained.

Returns:

the FileAnnotationData contained.