net.sf.basedb.core.data
Class ImageData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.ImageData

All Implemented Interfaces:

FileAttachableData, IdentifiableData, LoggableData, NameableData, RemovableData

public class ImageData
extends BasicData
implements NameableData, RemovableData, FileAttachableData, LoggableData

This class holds information about an image produced by scanning a hybridization.

Version:

2.0

Author:

Nicklas

See Also:

Image, Hybridzations and raw data overview

Last modified

$Date: 2009-08-19 14:09:14 +0200 (Wed, 19 Aug 2009) $

Hibernate: class

table="`Images`" lazy="false"

Field Summary

private String	description
private FileData	file
private int	format
private String	name
private boolean	preview
private boolean	removed
private ScanData	scan

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

ImageData()

Method Summary

String	getDescription() Get the description for the item.
FileData	getFile() Get the file that is attached to the item.
int	getFormat() Get the format of the file. 0 = unknown, 1 = TIFF, 2 = JPEG
String	getName() Get the name of the item.
ScanData	getScan() Get the scan that produced this image.
boolean	isPreview() A boolean value indicating if this image is a preview image or the full-sized image.
boolean	isRemoved() Check if the removed flag is set for this item.
void	setDescription(String description) Set the description for the item.
void	setFile(FileData file) Attach a file to the item.
void	setFormat(int format)
void	setName(String name) Set the name of the item.
void	setPreview(boolean preview)
void	setRemoved(boolean removed) Set the removed flag for this item.
void	setScan(ScanData scan)

Methods inherited from class net.sf.basedb.core.data.BasicData

equals, getId, getVersion, hashCode, setId, setVersion, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.basedb.core.data.IdentifiableData

getId, getVersion

Field Detail

name

private String name

description

private String description

removed

private boolean removed

file

private FileData file

scan

private ScanData scan

format

private int format

preview

private boolean preview

Constructor Detail

ImageData

public ImageData()

Method Detail

getName

public String getName()

Description copied from interface: NameableData

Get the name of the item.

Specified by:

getName in interface NameableData

Returns:

A String with the name of the item

setName

public void setName(String name)

Description copied from interface: NameableData

Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.

Specified by:

setName in interface NameableData

Parameters:

name - The new name for the item

getDescription

public String getDescription()

Description copied from interface: NameableData

Get the description for the item.

Specified by:

getDescription in interface NameableData

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)

Description copied from interface: NameableData

Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.

Specified by:

setDescription in interface NameableData

Parameters:

description - The new description for the item

isRemoved

public boolean isRemoved()

Description copied from interface: RemovableData

Check if the removed flag is set for this item.

Specified by:

isRemoved in interface RemovableData

Returns:

TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)

Description copied from interface: RemovableData

Set the removed flag for this item.

Specified by:

setRemoved in interface RemovableData

Parameters:

removed - TRUE if the item should be flagged as removed, FALSE otherwise

getFile

public FileData getFile()

Description copied from interface: FileAttachableData

Get the file that is attached to the item.

Specified by:

getFile in interface FileAttachableData

Returns:

A FileData object or null if no file is attached

setFile

public void setFile(FileData file)

Description copied from interface: FileAttachableData

Attach a file to the item. Null is allowed.

Specified by:

setFile in interface FileAttachableData

getScan

public ScanData getScan()

Get the scan that produced this image.

Hibernate: many-to-one

column="`scan_id`" not-null="true" update="false" outer-join="false"

setScan

public void setScan(ScanData scan)

getFormat

public int getFormat()

Get the format of the file. 0 = unknown, 1 = TIFF, 2 = JPEG

Hibernate: property

column="`format`" type="int" not-null="true"

setFormat

public void setFormat(int format)

isPreview

public boolean isPreview()

A boolean value indicating if this image is a preview image or the full-sized image.

Hibernate: property

column="`is_preview`" type="boolean" not-null="true"

setPreview

public void setPreview(boolean preview)