pojos
Class FileAnnotationData

java.lang.Object
  extended by pojos.DataObject
      extended by pojos.AnnotationData
          extended by pojos.FileAnnotationData

public class FileAnnotationData
extends AnnotationData

Annotation to upload files to the server.

Since:
OME3.0
Version:
3.0 (Internal version: $Revision: $Date: $)
Author:
Jean-Marie Burel      j.burel@dundee.ac.uk, Donald MacDonald      donald@lifesci.dundee.ac.uk

Field Summary
static String COMPANION_FILE_NS
          The name space used to indicate that the FileAnnotation is a companion file.
static String CSV
          Identifies the CSV file formats.
static String EDITOR_EXPERIMENT_NS
          The name space used to indicate that the FileAnnotation is an experiment.
static String EDITOR_PROTOCOL_NS
          The name space used to indicate that the FileAnnotation is a protocol.
static String EXPERIMENTER_PHOTO_NS
          The name space used to identify the experimenter photo.
static String FLIM_NS
          Identifies the FLIM namespace.
static String HTM
          Identifies the HTM file formats.
static String HTML
          Identifies the HTML file formats.
static String MEASUREMENT_NS
          The name space used to indicate that the FileAnnotation is a Measurement file.
static String MOVIE_NS
          The name space used to indicate that the FileAnnotation is a movie.
static String MS_EXCEL
          Identifies the Excel file formats.
static String MS_POWER_POINT
          Identifies the Power point file formats.
static String MS_POWER_POINT_SHOW
          Identifies the Power point file formats.
static String MS_POWER_POINT_X
          Identifies the Power point file formats.
static String MS_WORD
          Identifies the Word file formats.
static String MS_WORD_X
          Identifies the Word file formats.
static String PDF
          Identifies the PDF file formats.
static String RTF
          Identifies the RTF file formats.
static String TEXT
          Identifies the Text file formats.
static String UNKNOWN
          Indicates that the format is not recognized.
static String XML
          Identifies the XML file formats.
 
Constructor Summary
FileAnnotationData(File file)
          Creates a new instance.
FileAnnotationData(omero.model.FileAnnotation annotation)
          Creates a new instance.
 
Method Summary
 File getAttachedFile()
          Returns the file to upload to the server.
 Object getContent()
          Returns the original file.
 String getContentAsString()
          Returns the absolute path to the file
 String getDescription()
          Returns the description of the annotation.
 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.
 void setContent(Object content)
          Sets the text annotation.
 void setDescription(String description)
          Sets the description of the annotation.
 
Methods inherited from class pojos.AnnotationData
getLastModified, getNameSpace, setNameSpace
 
Methods inherited from class pojos.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, getCreated, getDetails, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EXPERIMENTER_PHOTO_NS

public static final String EXPERIMENTER_PHOTO_NS
The name space used to identify the experimenter photo.

See Also:
Constant Field Values

COMPANION_FILE_NS

public static final String COMPANION_FILE_NS
The name space used to indicate that the FileAnnotation is a companion file.

See Also:
Constant Field Values

EDITOR_PROTOCOL_NS

public static final String EDITOR_PROTOCOL_NS
The name space used to indicate that the FileAnnotation is a protocol.

See Also:
Constant Field Values

EDITOR_EXPERIMENT_NS

public static final String EDITOR_EXPERIMENT_NS
The name space used to indicate that the FileAnnotation is an experiment.

See Also:
Constant Field Values

MOVIE_NS

public static final String MOVIE_NS
The name space used to indicate that the FileAnnotation is a movie.

See Also:
Constant Field Values

MEASUREMENT_NS

public static final String MEASUREMENT_NS
The name space used to indicate that the FileAnnotation is a Measurement file.

See Also:
Constant Field Values

FLIM_NS

public static final String FLIM_NS
Identifies the FLIM namespace.

See Also:
Constant Field Values

PDF

public static final String PDF
Identifies the PDF file formats.

See Also:
Constant Field Values

TEXT

public static final String TEXT
Identifies the Text file formats.

See Also:
Constant Field Values

CSV

public static final String CSV
Identifies the CSV file formats.

See Also:
Constant Field Values

XML

public static final String XML
Identifies the XML file formats.

See Also:
Constant Field Values

HTML

public static final String HTML
Identifies the HTML file formats.

See Also:
Constant Field Values

HTM

public static final String HTM
Identifies the HTM file formats.

See Also:
Constant Field Values

MS_WORD

public static final String MS_WORD
Identifies the Word file formats.

See Also:
Constant Field Values

MS_WORD_X

public static final String MS_WORD_X
Identifies the Word file formats.

See Also:
Constant Field Values

MS_EXCEL

public static final String MS_EXCEL
Identifies the Excel file formats.

See Also:
Constant Field Values

MS_POWER_POINT

public static final String MS_POWER_POINT
Identifies the Power point file formats.

See Also:
Constant Field Values

MS_POWER_POINT_X

public static final String MS_POWER_POINT_X
Identifies the Power point file formats.

See Also:
Constant Field Values

MS_POWER_POINT_SHOW

public static final String MS_POWER_POINT_SHOW
Identifies the Power point file formats.

See Also:
Constant Field Values

RTF

public static final String RTF
Identifies the RTF file formats.

See Also:
Constant Field Values

UNKNOWN

public static final String UNKNOWN
Indicates that the format is not recognized.

See Also:
Constant Field Values
Constructor Detail

FileAnnotationData

public FileAnnotationData(File file)
Creates a new instance.

Parameters:
file - The file to attach.

FileAnnotationData

public FileAnnotationData(omero.model.FileAnnotation annotation)
Creates a new instance.

Parameters:
annotation - The annotation to wrap.
Method Detail

getOriginalMimetype

public String getOriginalMimetype()
Returns the format of the original file.

Returns:
See above.

setDescription

public void setDescription(String description)
Sets the description of the annotation.

Parameters:
description - The value to set.

getDescription

public String getDescription()
Returns the description of the annotation.

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.

getContent

public Object getContent()
Returns the original file.

Specified by:
getContent in class AnnotationData
Returns:
See above.
See Also:
AnnotationData.getContent()

getContentAsString

public String getContentAsString()
Returns the absolute path to the file

Specified by:
getContentAsString in class AnnotationData
Returns:
See above
See Also:
AnnotationData.getContentAsString()

isMovieFile

public boolean isMovieFile()
Returns true if it is a movie file. false otherwise.

Returns:
See above.

setContent

public void setContent(Object content)
Sets the text annotation.

Specified by:
setContent in class AnnotationData
Parameters:
content - The value to set.
See Also:
AnnotationData.setContent(Object)


OmeroJava Api

Version: Beta4.2.1-r8614-Beta4.2-b41

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