net.sf.basedb.util.overview.loader
Class ProtocolParameterLoader

java.lang.Object
  net.sf.basedb.util.overview.loader.AbstractNodeLoader<I>
      net.sf.basedb.util.overview.loader.BasicItemNodeLoader<AnnotationType>
          net.sf.basedb.util.overview.loader.ProtocolParameterLoader

All Implemented Interfaces:

NodeLoader<AnnotationType>

public class ProtocolParameterLoader
extends BasicItemNodeLoader<AnnotationType>

Node loader implementation for protocol parameters. Protocol parameters are loaded as property-type child nodes of a protocol. The protocol must have a parent node with an item that is Annotatable since this is were the parameter values are stored.

Version:

2.10

Author:

Nicklas

Last modified

$Date: 2009-02-11 09:49:39 +0100 (Wed, 11 Feb 2009) $

Field Summary

Fields inherited from class net.sf.basedb.util.overview.loader.BasicItemNodeLoader

ALLOW_ROOT_NODE, allowAsRootNode, DENY_ROOT_NODE, factoryKey, nameGenerator

Constructor Summary

ProtocolParameterLoader()

Method Summary

Node	createPropertyNode(DbControl dc, OverviewContext context, Node protocolNode) Create a property node for the given parent node.

Methods inherited from class net.sf.basedb.util.overview.loader.BasicItemNodeLoader

createItemNode, createRootNode, getNodeFactory, getNodeFactory, getNodeLoader, getNodeLoaderFactory, getNodeValidator, getNodeValidatorFactory, postValidateFolder

Methods inherited from class net.sf.basedb.util.overview.loader.AbstractNodeLoader

createForwardNode, createReverseNode, loadChildNodes, loadChildNodesOfFolderNode, loadChildNodesOfItemNode, loadForwardChildNodes, loadPropertyChildNodes, loadReverseChildNodes

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolParameterLoader

public ProtocolParameterLoader()

Method Detail

createPropertyNode

public Node createPropertyNode(DbControl dc,
                               OverviewContext context,
                               Node protocolNode)

Description copied from interface: NodeLoader

Create a property node for the given parent node. A property node is a node that is not on the main parent-child path. It is typically a node that can't be used a root node (for example, a protocol or software). If the parent node can have many properties of this type the loader can decide if it should first create a folder-type node and put the children inside the folder, or if all child nodes should be created directly in the parent node. In the first case, the folder node should be returned. In the latter case, null should be returned.

The direction of the node(s) should usually be ChildNodeDirection.NONE, but it may also be ChildNodeDirection.PROPERTY in case the property has sub-properties. One example is the ProtocolLoader which loads the protocol parameters as child nodes.

In case there is an error (permission denied, etc.) ChildNodeDirection.NONE should be used. If there is no property item null should be returned (but this may also indicate that more than one node was created).

Errors, missing items, etc. should be reported as failures to the OverviewContext.

Specified by:

createPropertyNode in interface NodeLoader<AnnotationType>

Overrides:

createPropertyNode in class AbstractNodeLoader<AnnotationType>

Parameters:

dc - The DbControl to use for database access

context - The overview context

protocolNode - The parent node

Returns:

A node (may be a folder-type node with many subnodes), or null