net.sf.basedb.core.data
Class PlateMappingData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.OwnedData
          net.sf.basedb.core.data.SharedData
              net.sf.basedb.core.data.CommonData
                  net.sf.basedb.core.data.PlateMappingData

All Implemented Interfaces:

IdentifiableData, NameableData, OwnableData, RegisteredData, RemovableData, ShareableData

public class PlateMappingData
extends CommonData
implements RegisteredData

This class holds information about a plate mapping.

Version:

2.0

Author:

Nicklas

See Also:

PlateMapping, Array LIMS - Plates overview

Last modified

$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $

Hibernate: class

table="`PlateMappings`" lazy="true"

Field Summary

private int	destinationCount
private PlateGeometryData	destinationGeometry
private Map<MappingCoordinate,MappingCoordinate>	details
private Date	entryDate
private String	image
static int	MAX_IMAGE_LENGTH The maximum length of the image name that can be stored in the database.
private int	sourceCount
private PlateGeometryData	sourceGeometry

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

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

PlateMappingData()

Method Summary

int	getDestinationCount() The produced number of destination plates.
PlateGeometryData	getDestinationGeometry() The required geometry of destination plates in this mapping.
Map<MappingCoordinate,MappingCoordinate>	getDetails() For each destination coordinate we can get the source coordinate.
Date	getEntryDate() Get the date this item was added to the database.
String	getImage() An optional name of a small image with a graphical representation of the mapping.
int	getSourceCount() The required number of source plates.
PlateGeometryData	getSourceGeometry() The required geometry of source plates in this mapping.
void	setDestinationCount(int destinationCount)
void	setDestinationGeometry(PlateGeometryData destinationGeometry)
(package private) void	setDetails(Map<MappingCoordinate,MappingCoordinate> details)
void	setEntryDate(Date entryDate)
void	setImage(String image)
void	setSourceCount(int sourceCount)
void	setSourceGeometry(PlateGeometryData sourceGeometry)

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

getDescription, getName, isRemoved, setDescription, setName, setRemoved

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

getItemKey, getProjectKey, setItemKey, setProjectKey

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

getOwner, setOwner

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

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

getOwner, setOwner

Field Detail

entryDate

private Date entryDate

sourceGeometry

private PlateGeometryData sourceGeometry

destinationGeometry

private PlateGeometryData destinationGeometry

sourceCount

private int sourceCount

destinationCount

private int destinationCount

MAX_IMAGE_LENGTH

public static final int MAX_IMAGE_LENGTH

The maximum length of the image name that can be stored in the database.

See Also:

setImage(String), Constant Field Values

image

private String image

details

private Map<MappingCoordinate,MappingCoordinate> details

Constructor Detail

PlateMappingData

public PlateMappingData()

Method Detail

getEntryDate

public Date getEntryDate()

Description copied from interface: RegisteredData

Get the date this item was added to the database. The value is generated at creation time and can't be modified later.

Specified by:

getEntryDate in interface RegisteredData

setEntryDate

public void setEntryDate(Date entryDate)

getSourceGeometry

public PlateGeometryData getSourceGeometry()

The required geometry of source plates in this mapping.

Hibernate: many-to-one

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

setSourceGeometry

public void setSourceGeometry(PlateGeometryData sourceGeometry)

getDestinationGeometry

public PlateGeometryData getDestinationGeometry()

The required geometry of destination plates in this mapping.

Hibernate: many-to-one

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

setDestinationGeometry

public void setDestinationGeometry(PlateGeometryData destinationGeometry)

getSourceCount

public int getSourceCount()

The required number of source plates.

Hibernate: property

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

setSourceCount

public void setSourceCount(int sourceCount)

getDestinationCount

public int getDestinationCount()

The produced number of destination plates.

Hibernate: property

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

setDestinationCount

public void setDestinationCount(int destinationCount)

getImage

public String getImage()

An optional name of a small image with a graphical representation of the mapping.

Hibernate: property

column="`image`" type="string" size="255" not-null="false"

setImage

public void setImage(String image)

getDetails

public Map<MappingCoordinate,MappingCoordinate> getDetails()

For each destination coordinate we can get the source coordinate. The mapping for this element is specified in hibernate-properties-PlateMappingData.xml because we must supply different column names for the properties of MappingCoordinate objectes depending on if it is a destination coordinate (map key) or source coordinate (map value), which is not supported by XDoclet. The structure of the mapping is: hibernate.map table="`PlateMappingDetails`" lazy="true" cascade="delete" hibernate.collection-key column="`platemapping_id`" type="int" hibernate.collection-composite-index class="net.sf.basedb.core.data.MappingCoordinate" hibernate.collection-composite-element class="net.sf.basedb.core.data.MappingCoordinate"

setDetails

void setDetails(Map<MappingCoordinate,MappingCoordinate> details)