FileAnnotationData (omero-gateway 5.9.1 API)

java.lang.Object
- omero.gateway.model.DataObject
- - omero.gateway.model.AnnotationData
  - - omero.gateway.model.FileAnnotationData

public class FileAnnotationData
extends AnnotationData

Annotation to upload files to the server.

Since:: OME3.0

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BULK_ANNOTATIONS_NS` The name space used to indicate that the `FileAnnotation` is a `Bulk Annotations` file.
`static java.lang.String`	`COMPANION_FILE_NS` The name space used to indicate that the `FileAnnotation` is a companion file.
`static java.lang.String`	`CSV` Identifies the `CSV` file formats.
`static java.lang.String`	`EXPERIMENTER_PHOTO_NS` The name space used to identify the experimenter photo.
`static java.lang.String`	`FLIM_NS` Identifies the FLIM namespace.
`static java.lang.String`	`HTM` Identifies the `HTM` file formats.
`static java.lang.String`	`HTML` Identifies the `HTML` file formats.
`static java.lang.String`	`LOG_FILE_NS` The name space used to indicate that the `FileAnnotation` is an import log file.
`static java.lang.String`	`MEASUREMENT_NS` The name space used to indicate that the `FileAnnotation` is a `Measurement` file.
`static java.lang.String`	`MOVIE_NS` The name space used to indicate that the `FileAnnotation` is a movie.
`static java.lang.String`	`MS_EXCEL` Identifies the `Excel` file formats.
`static java.lang.String`	`MS_POWER_POINT` Identifies the `Power point` file formats.
`static java.lang.String`	`MS_POWER_POINT_SHOW` Identifies the `Power point` file formats.
`static java.lang.String`	`MS_POWER_POINT_X` Identifies the `Power point` file formats.
`static java.lang.String`	`MS_WORD` Identifies the `Word` file formats.
`static java.lang.String`	`MS_WORD_X` Identifies the `Word` file formats.
`static java.lang.String`	`ORIGINAL_METADATA_NAME` The default name for the original metadata file.
`static java.lang.String`	`PDF` Identifies the `PDF` file formats.
`static java.lang.String`	`RTF` Identifies the `RTF` file formats.
`static java.lang.String`	`TEXT` Identifies the `Text` file formats.
`static java.lang.String`	`UNKNOWN` Indicates that the format is not recognized.
`static java.lang.String`	`XML` Identifies the `XML` file formats.

Fields inherited from class omero.gateway.model.AnnotationData
FILE_TRANSFER_NS

Constructor Summary

Constructors
Constructor and Description

FileAnnotationData(java.io.File file)
Creates a new instance.

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

Constructors
Constructor and Description
`FileAnnotationData(java.io.File file)` Creates a new instance.
`FileAnnotationData(omero.model.FileAnnotation annotation)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.io.File`	`getAttachedFile()` Returns the file to upload to the server.
`java.lang.Object`	`getContent()` Returns the original file.
`java.lang.String`	`getContentAsString()` Returns the absolute path to the file
`java.lang.String`	`getDescription()` Returns the description of the annotation.
`omero.model.OriginalFile`	`getFile()` Returns the original file if loaded, `null` otherwise.
`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.
`void`	`setContent(java.lang.Object content)` Sets the text annotation.
`void`	`setDescription(java.lang.String description)` Sets the description of the annotation.

Methods inherited from class omero.gateway.model.AnnotationData
getLastModified, getNameSpace, setNameSpace

Methods inherited from class omero.gateway.model.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlaneInfo, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, 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
  - FLIM_NS
```
public static final java.lang.String FLIM_NS
```
    Identifies the FLIM namespace.
    
    See Also:
    
    Constant Field Values
  - EXPERIMENTER_PHOTO_NS
```
public static final java.lang.String EXPERIMENTER_PHOTO_NS
```
    The name space used to identify the experimenter photo.
    
    See Also:
    
    Constant Field Values
  - COMPANION_FILE_NS
```
public static final java.lang.String COMPANION_FILE_NS
```
    The name space used to indicate that the FileAnnotation is a companion file.
    
    See Also:
    
    Constant Field Values
  - LOG_FILE_NS
```
public static final java.lang.String LOG_FILE_NS
```
    The name space used to indicate that the FileAnnotation is an import log file.
    
    See Also:
    
    Constant Field Values
  - MOVIE_NS
```
public static final java.lang.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 java.lang.String MEASUREMENT_NS
```
    The name space used to indicate that the FileAnnotation is a Measurement file.
    
    See Also:
    
    Constant Field Values
  - BULK_ANNOTATIONS_NS
```
public static final java.lang.String BULK_ANNOTATIONS_NS
```
    The name space used to indicate that the FileAnnotation is a Bulk Annotations file.
    
    See Also:
    
    Constant Field Values
  - ORIGINAL_METADATA_NAME
```
public static final java.lang.String ORIGINAL_METADATA_NAME
```
    The default name for the original metadata file.
    
    See Also:
    
    Constant Field Values
  - PDF
```
public static final java.lang.String PDF
```
    Identifies the PDF file formats.
    
    See Also:
    
    Constant Field Values
  - TEXT
```
public static final java.lang.String TEXT
```
    Identifies the Text file formats.
    
    See Also:
    
    Constant Field Values
  - CSV
```
public static final java.lang.String CSV
```
    Identifies the CSV file formats.
    
    See Also:
    
    Constant Field Values
  - XML
```
public static final java.lang.String XML
```
    Identifies the XML file formats.
    
    See Also:
    
    Constant Field Values
  - HTML
```
public static final java.lang.String HTML
```
    Identifies the HTML file formats.
    
    See Also:
    
    Constant Field Values
  - HTM
```
public static final java.lang.String HTM
```
    Identifies the HTM file formats.
    
    See Also:
    
    Constant Field Values
  - MS_WORD
```
public static final java.lang.String MS_WORD
```
    Identifies the Word file formats.
    
    See Also:
    
    Constant Field Values
  - MS_WORD_X
```
public static final java.lang.String MS_WORD_X
```
    Identifies the Word file formats.
    
    See Also:
    
    Constant Field Values
  - MS_EXCEL
```
public static final java.lang.String MS_EXCEL
```
    Identifies the Excel file formats.
    
    See Also:
    
    Constant Field Values
  - MS_POWER_POINT
```
public static final java.lang.String MS_POWER_POINT
```
    Identifies the Power point file formats.
    
    See Also:
    
    Constant Field Values
  - MS_POWER_POINT_X
```
public static final java.lang.String MS_POWER_POINT_X
```
    Identifies the Power point file formats.
    
    See Also:
    
    Constant Field Values
  - MS_POWER_POINT_SHOW
```
public static final java.lang.String MS_POWER_POINT_SHOW
```
    Identifies the Power point file formats.
    
    See Also:
    
    Constant Field Values
  - RTF
```
public static final java.lang.String RTF
```
    Identifies the RTF file formats.
    
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final java.lang.String UNKNOWN
```
    Indicates that the format is not recognized.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FileAnnotationData
```
public FileAnnotationData(java.io.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
  - getFile
```
public omero.model.OriginalFile getFile()
```
    Returns the original file if loaded, null otherwise.
    
    Returns:
    
    See above.
  - getOriginalMimetype
```
public java.lang.String getOriginalMimetype()
```
    Returns the format of the original file.
    
    Returns:
    
    See above.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description of the annotation.
    
    Overrides:
    
    setDescription in class AnnotationData
    
    Parameters:
    
    description - The value to set.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description of the annotation.
    
    Overrides:
    
    getDescription in class AnnotationData
    
    Returns:
    
    See above.
  - getServerFileMimetype
```
public java.lang.String getServerFileMimetype()
```
    Returns the file format as defined by the specification, corresponding to the file extension.
    
    Returns:
    
    See above.
  - getFileFormat
```
public java.lang.String getFileFormat()
```
    Returns the format of the uploaded file.
    
    Returns:
    
    See above.
  - getFileKind
```
public java.lang.String getFileKind()
```
    Returns a user readable description of the file.
    
    Returns:
    
    See above.
  - getAttachedFile
```
public java.io.File getAttachedFile()
```
    Returns the file to upload to the server.
    
    Returns:
    
    See above.
  - getFileName
```
public java.lang.String getFileName()
```
    Returns the name of the file.
    
    Returns:
    
    See above.
  - getFilePath
```
public java.lang.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 java.lang.Object getContent()
```
    Returns the original file.
    
    Specified by:
    
    getContent in class AnnotationData
    
    Returns:
    
    See above.
    
    See Also:
    
    AnnotationData.getContent()
  - getContentAsString
```
public java.lang.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(java.lang.Object content)
```
    Sets the text annotation.
    
    Specified by:
    
    setContent in class AnnotationData
    
    Parameters:
    
    content - The value to set.
    
    See Also:
    
    AnnotationData.setContent(Object)

Class FileAnnotationData

Field Summary

Fields inherited from class omero.gateway.model.AnnotationData

Constructor Summary

Method Summary

Methods inherited from class omero.gateway.model.AnnotationData

Methods inherited from class omero.gateway.model.DataObject

Methods inherited from class java.lang.Object

Field Detail

FLIM_NS

EXPERIMENTER_PHOTO_NS

COMPANION_FILE_NS

LOG_FILE_NS

MOVIE_NS

MEASUREMENT_NS

BULK_ANNOTATIONS_NS

ORIGINAL_METADATA_NAME

PDF

TEXT

CSV

XML

HTML

HTM

MS_WORD

MS_WORD_X

MS_EXCEL

MS_POWER_POINT

MS_POWER_POINT_X

MS_POWER_POINT_SHOW

RTF

UNKNOWN

Constructor Detail

FileAnnotationData

FileAnnotationData

Method Detail

getFile

getOriginalMimetype

setDescription

getDescription

getServerFileMimetype

getFileFormat

getFileKind

getAttachedFile

getFileName

getFilePath

getFileSize

getFileID

getContent

getContentAsString

isMovieFile

setContent