net.sf.basedb.core.data
Class FeatureData

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

All Implemented Interfaces:

BatchableData, IdentifiableData

public class FeatureData
extends BasicData
implements BatchableData

This class holds information about a regular feature.

Version:

2.0

Author:

enell, Nicklas

See Also:

Feature, Array LIMS - arrays overview

Last modified

$Date: 2009-07-28 11:06:46 +0200 (Tue, 28 Jul 2009) $

Hibernate: class

table="`Features`" lazy="true"

Field Summary

private ArrayDesignBlockData	arrayDesignBlock
private int	column
private String	externalId
static int	MAX_EXTERNAL_ID_LENGTH The maximum length of the external ID that can be stored in the database.
private int	position
private ReporterData	reporter
private int	row
private WellData	well

Constructor Summary

FeatureData()

FeatureData(ArrayDesignBlockData arrayDesignBlock, ReporterData reporter)
Create a new feature which is linked to a reporter only.

FeatureData(ArrayDesignBlockData arrayDesignBlock, WellData well)
Create a new feature which is linked to a well.

Method Summary

(package private) ArrayDesignBlockData	getArrayDesignBlock() Get the arraydesignblock of this feature.
int	getColumn() Get the column coordinate of the feature.
String	getExternalId() Get the external id for this FeatureData item.
int	getPosition() Get the position number of the feature.
ReporterData	getReporter() Get the reporter of the feature.
int	getRow() Get the row coordinate of the feature.
(package private) WellData	getWell() Get the well of the feature.
(package private) void	setArrayDesignBlock(ArrayDesignBlockData arrayDesignBlock)
void	setColumn(int column)
void	setExternalId(String externalId)
void	setPosition(int position) This method was private until 2.6.
(package private) void	setReporter(ReporterData reporter)
void	setRow(int row)
(package private) void	setWell(WellData well)

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

column

private int column

row

private int row

position

private int position

MAX_EXTERNAL_ID_LENGTH

public static final int MAX_EXTERNAL_ID_LENGTH

The maximum length of the external ID that can be stored in the database.

See Also:

setExternalId(String), Constant Field Values

externalId

private String externalId

arrayDesignBlock

private ArrayDesignBlockData arrayDesignBlock

reporter

private ReporterData reporter

well

private WellData well

Constructor Detail

FeatureData

FeatureData()

FeatureData

public FeatureData(ArrayDesignBlockData arrayDesignBlock,
                   WellData well)

Create a new feature which is linked to a well. The reporter of the well is copied to the feature.

FeatureData

public FeatureData(ArrayDesignBlockData arrayDesignBlock,
                   ReporterData reporter)

Create a new feature which is linked to a reporter only.

Method Detail

getColumn

public int getColumn()

Get the column coordinate of the feature.

Hibernate: property

type="int" update="false"

Hibernate: column

name="`column`" not-null="true"

setColumn

public void setColumn(int column)

getRow

public int getRow()

Get the row coordinate of the feature.

Hibernate: property

type="int" update="false"

Hibernate: column

name="`row`" not-null="true"

setRow

public void setRow(int row)

getPosition

public int getPosition()

Get the position number of the feature. The value is automatically assigned by the core.

Hibernate: property

column="`position`" type="int" not-null="true" update="false"

setPosition

public void setPosition(int position)

This method was private until 2.6. The value will be overwritten with an autogenerated value unless the feature identification method is POSITION. The value must be a positive integer.

Since:

2.6

getExternalId

public String getExternalId()

Get the external id for this FeatureData item. If given, it must be unique per array design.

Returns:

The features external ID.

Since:

2.6

Hibernate: property

column="`external_id`" type="string" length="255" not-null="false" update="false"

setExternalId

public void setExternalId(String externalId)

getArrayDesignBlock

ArrayDesignBlockData getArrayDesignBlock()

Get the arraydesignblock of this feature. Cannot be public since we don't want to expose data objects to clients.

Hibernate: column

name="`arraydesignblock_id`" not-null="true"

Hibernate: many-to-one

outer-join="false" update="false"

setArrayDesignBlock

void setArrayDesignBlock(ArrayDesignBlockData arrayDesignBlock)

getReporter

public ReporterData getReporter()

Get the reporter of the feature. This property is mapped in the hibernate-properties-FeatureData.xml file since it must be mapped with a cascade="evict" which is not supported by XDoclet.

setReporter

void setReporter(ReporterData reporter)

getWell

WellData getWell()

Get the well of the feature. Cannot be public since we don't want to expose data objects to clients.

Hibernate: many-to-one

column="`well_id`" not-null="false" update="false" outer-join="false"

setWell

void setWell(WellData well)