diva.pod
Class Protocol

java.lang.Object
  extended by diva.pod.Protocol
Direct Known Subclasses:
Protocol.Graph, Protocol.Layout

public abstract class Protocol
extends Object

A Protocol is a reification of the concept of protocol, which underlies the connection of Generators, Pods, and Views. Each supported protocol will have a corresponding class, and this class is expected to be implemented as a singleton (ie it must have a private constructor).

The protocols implemented by the diva.pod package are defined as inner classes here, so that nice names of the form Protocol.Graph result. However, additional protocols can be created simply by subclassing Protocol.

Version:
$Revision: 1.2 $
Author:
John Reekie

Nested Class Summary
 class Protocol.Graph
          The Graph protocol.
 class Protocol.Layout
          The Layout protocol.
 
Constructor Summary
protected Protocol(String name)
          Subclasses must have a private constructor that calls this constructor with the protocol name.
 
Method Summary
abstract  Protocol getInstance()
          Get the single instance of this protocol class.
 String getName()
          Get the name of this protocol.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Protocol

protected Protocol(String name)
Subclasses must have a private constructor that calls this constructor with the protocol name.

Method Detail

getName

public String getName()
Get the name of this protocol.


getInstance

public abstract Protocol getInstance()
Get the single instance of this protocol class.



Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.