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

java.lang.Object
  net.sf.basedb.util.overview.loader.AbstractNodeLoader<I>
      net.sf.basedb.util.overview.loader.BasicItemNodeLoader<Protocol>
          net.sf.basedb.util.overview.loader.ProtocolLoader

All Implemented Interfaces:

NodeLoader<Protocol>

public class ProtocolLoader
extends BasicItemNodeLoader<Protocol>

Node loader implementation for protocols. Protocols must be loaded as property nodes. It can't be a root node or a forward/reverse-loading node. The property node itself is created as a property-loading node that loads the protocol parameters when asked to load it's children.

Version:

2.10

Author:

Nicklas

Last modified

$Date: 2009-05-20 07:45:22 +0200 (Wed, 20 May 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

ProtocolLoader()

Method Summary

Node	createPropertyNode(DbControl dc, OverviewContext context, Node parentNode) Create a property node for the given parent node.
protected void	loadPropertyChildNodes(DbControl dc, OverviewContext context, Node protocolNode) Loads annotations and protocol parameters for the given protocol 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, loadReverseChildNodes

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolLoader

public ProtocolLoader()

Method Detail

createPropertyNode

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

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<Protocol>

Overrides:

createPropertyNode in class AbstractNodeLoader<Protocol>

Parameters:

dc - The DbControl to use for database access

context - The overview context

parentNode - The parent node

Returns:

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

loadPropertyChildNodes

protected void loadPropertyChildNodes(DbControl dc,
                                      OverviewContext context,
                                      Node protocolNode)

Loads annotations and protocol parameters for the given protocol node.

Overrides:

loadPropertyChildNodes in class AbstractNodeLoader<Protocol>

See Also:

RawBioAssayLoader.createForwardNode(DbControl, OverviewContext, Node)