gov.sns.xal.model.gen
Class GenerationRule

java.lang.Object
  |
  +--gov.sns.xal.model.gen.GenerationRule

All Implemented Interfaces:

IRule

public abstract class GenerationRule

extends java.lang.Object

implements IRule

Constructor Summary

protected

GenerationRule(java.lang.String[] arrTypes) Creates a new instance of GenerationRule

Method Summary

abstract java.util.List	getElements(java.util.Set setNodeCombin)
java.util.Set	getNodeCombination() Returns a set of AcceleratorNode type string identifiers (order is not important).

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerationRule

protected GenerationRule(java.lang.String[] arrTypes)

Creates a new instance of GenerationRule

Parameters:

arrTypes - string array of node types

Method Detail

getElements

public abstract java.util.List getElements(java.util.Set setNodeCombin)
                                    throws GenerationException

Specified by:

getElements in interface IRule

GenerationException

getNodeCombination

public java.util.Set getNodeCombination()

Description copied from interface: IRule

Returns a set of AcceleratorNode type string identifiers (order is not important). The class implementing this interface is able to generate an order list of Element objects that model this node combination.

Specified by:

getNodeCombination in interface IRule

Returns:

set (unordered) of AcceleratorNode objects that generation rule handles