omero.gateway.model

Class FileData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.FileData

public class FileData
extends DataObject

DataObject used to handle the file visible via FS.

Since:

3.0-Beta4

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
FileData(omero.model.OriginalFile object) Creates a new instance.
FileData(omero.model.OriginalFile object, boolean directory) Creates a new instance.
FileData(omero.model.OriginalFile object, boolean directory, boolean hidden) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
String	getAbsolutePath() Returns the absolute path.
String	getDescription() Returns the description of the file.
String	getName() Returns the name of the file.
String	getPath() Returns the (relative) path of the file.
boolean	isDirectory() Returns true if the file is a directory, false otherwise.
boolean	isHidden() Returns true if the file is hidden, false otherwise.
long	lastModified() Returns when the file was last modified.
void	setDescription(String description) Sets the description.
void	setRegisteredFile(omero.model.OriginalFile object) Sets the registered file.
void	setRepositoryPath(String path) Sets the path to the parent.

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, 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

Constructor Detail

FileData

public FileData(omero.model.OriginalFile object)

Creates a new instance.

Parameters:

object - The object to store.

FileData

public FileData(omero.model.OriginalFile object,
                boolean directory)

Creates a new instance.

Parameters:

object - The object to store.

directory - Pass true if the object is a directory, false otherwise.

FileData

public FileData(omero.model.OriginalFile object,
                boolean directory,
                boolean hidden)

Creates a new instance.

Parameters:

object - The object to store.

directory - Pass true if the object is a directory, false otherwise.

Method Detail

setRegisteredFile

public void setRegisteredFile(omero.model.OriginalFile object)

Sets the registered file.

Parameters:

object - The object to store.

getDescription

public String getDescription()

Returns the description of the file.

Returns:

See above.

setDescription

public void setDescription(String description)

Sets the description.

Parameters:

description - The value to set.

setRepositoryPath

public void setRepositoryPath(String path)

Sets the path to the parent.

Parameters:

path - The value to set.

getName

public String getName()

Returns the name of the file.

Returns:

See above.

getPath

public String getPath()

Returns the (relative) path of the file.

Returns:

See above.

getAbsolutePath

public String getAbsolutePath()

Returns the absolute path.

Returns:

See above.

isHidden

public boolean isHidden()

Returns true if the file is hidden, false otherwise.

Returns:

See above.

lastModified

public long lastModified()

Returns when the file was last modified.

Returns:

See above.

isDirectory

public boolean isDirectory()

Returns true if the file is a directory, false otherwise.

Returns:

See above.