3.2.1: 2012-12-13

net.sf.basedb.util.overview.node
Interface NodeNameGenerator<I>

All Known Implementing Classes:
AnnotationNameGenerator, AnyToAnyNameGenerator, BioMaterialListMemberNameGenerator, BioPlateNameGenerator, BioWellNameGenerator, ExtractNameGenerator, FileSetMemberNameGenerator, NameableNameGenerator

public interface NodeNameGenerator<I>

A name generator is an object that can create the name and title for a node when given the item that should be attached to the node. The name and title are used to create the new node: Node.Node(String, String, Node, BasicItem, ChildNodeDirection).

Version:
2.10
Author:
Nicklas
Last modified
$Date: 2011-10-21 13:15:41 +0200 (Fri, 21 Oct 2011) $

Method Summary
 String getDeniedNodeName(Node parentNode)
          Generate a name for a node when the item exists, but the current user doesn't have permission to access read the item.
 String getDeniedNodeTitle(Node parentNode)
          Generate a title for a node when the item exists, but the current user doesn't have permission to access read the item.
 String getMissingNodeName(Node parentNode)
          Generate a name for a node when the item is missing.
 String getMissingNodeTitle(Node parentNode)
          Generate a title for a node when the item is missing.
 String getNodeName(I item, Node parentNode)
          Generate a name for the new node that is about to be created.
 String getNodeTitle(I item, Node parentNode)
          Generate a title for the new node that is about to be created.
 

Method Detail

getMissingNodeName

String getMissingNodeName(Node parentNode)
Generate a name for a node when the item is missing.

Parameters:
parentNode - The parent node
Returns:
A name for the node

getMissingNodeTitle

String getMissingNodeTitle(Node parentNode)
Generate a title for a node when the item is missing.

Parameters:
parentNode - The parent node
Returns:
A title for the node

getDeniedNodeName

String getDeniedNodeName(Node parentNode)
Generate a name for a node when the item exists, but the current user doesn't have permission to access read the item.

Parameters:
parentNode - The parent node
Returns:
A name for the node

getDeniedNodeTitle

String getDeniedNodeTitle(Node parentNode)
Generate a title for a node when the item exists, but the current user doesn't have permission to access read the item.

Parameters:
parentNode - The parent node
Returns:
A name for the node

getNodeName

String getNodeName(I item,
                   Node parentNode)
Generate a name for the new node that is about to be created.

Parameters:
item - The item that is attached to the node (never null)
parentNode - The parent node of the new node
Returns:
A name for the node

getNodeTitle

String getNodeTitle(I item,
                    Node parentNode)
Generate a title for the new node that is about to be created.

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

3.2.1: 2012-12-13