Package net.sf.basedb.util.overview.node

Class BioPlateNameGenerator

java.lang.Object

net.sf.basedb.util.overview.node.NameableNameGenerator<BioPlate>

net.sf.basedb.util.overview.node.BioPlateNameGenerator

All Implemented Interfaces:

NodeNameGenerator<BioPlate>

public class BioPlateNameGenerator
extends NameableNameGenerator<BioPlate>

Name generator implementation for BioPlate items. The implementation use the NameableNameGenerator but appends the coordinate of the biomaterial if the parent node is a biomaterial node. Eg. My plate [A2]. If the parent node is a bioplate event, it appends the BioPlateEventParticipant.getRole() to the title.

Since:

3.2

Author:

Nicklas

Last modified

$Date$

Field Summary

Fields

Modifier and Type	Field	Description
private BioPlateEventParticipant	currentParticipant
private BioWell	currentWell

Constructor Summary

Constructors

Constructor	Description
BioPlateNameGenerator(String namePrefix, String titlePrefix)	Create a new name generator.

Method Summary

Modifier and Type	Method	Description
String	getNodeTitle(BioPlate item, Node parentNode)	The base of the title is generated by the superclass.
void	setCurrentBioWell(BioWell well)	Set the current biowell object that should be used when generating names for bioplates that are reached by navigating via a biomaterial.
void	setCurrentEventParticipant(BioPlateEventParticipant participant)	Set the current bioplate event participant object that should be used when generating names for bioplates that are part of a bioplate event.

Methods inherited from class net.sf.basedb.util.overview.node.NameableNameGenerator

getDeniedNodeName, getDeniedNodeTitle, getMissingNodeName, getMissingNodeTitle, getNodeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

currentParticipant

private BioPlateEventParticipant currentParticipant

currentWell

private BioWell currentWell

Constructor Details

BioPlateNameGenerator

public BioPlateNameGenerator(String namePrefix,
 String titlePrefix)

Create a new name generator.

Parameters:

namePrefix - The prefix to use in node names

titlePrefix - The prefix to use in node titles

Method Details

getNodeTitle

public String getNodeTitle(BioPlate item,
 Node parentNode)

The base of the title is generated by the superclass. This implementation adds a suffix to the title with the coordinate of the biomaterial if the parent node is a biomaterial node. If the parent node is a bioplate event, the role of the bioplate in the event is added.

Specified by:

getNodeTitle in interface NodeNameGenerator<BioPlate>

Overrides:

getNodeTitle in class NameableNameGenerator<BioPlate>

Parameters:

item - The item that is attached to the node (never null)

parentNode - The parent node of the new node

Returns:

A title for the node

setCurrentEventParticipant

public void setCurrentEventParticipant(BioPlateEventParticipant participant)

Set the current bioplate event participant object that should be used when generating names for bioplates that are part of a bioplate event.

Since:

3.3

setCurrentBioWell

public void setCurrentBioWell(BioWell well)

Set the current biowell object that should be used when generating names for bioplates that are reached by navigating via a biomaterial.

Since:

3.3