xal.smf.impl.qualify

Class KindQualifier

java.lang.Object

xal.smf.impl.qualify.KindQualifier

All Implemented Interfaces:

TypeQualifier

public class KindQualifier
extends java.lang.Object
implements TypeQualifier

KindQualifier is used to match nodes based upon the string type of nodes. For example, the official naming convention specifies names and short names for various elements in the accelerator (e.g. "Q" for quadrupole, "BPM" for a "beam position monitor". The user can construct a qualifier by specifying an element type by either its name or short name (usually given by the node's "s_strType" property).

Constructor Summary

Constructors

Constructor and Description
KindQualifier(java.lang.String newKind) Creates new KindQualifier

Method Summary

Modifier and Type	Method and Description
boolean	match(AcceleratorNode node) Determine if the specified node is a match based on this qualifier's criteria
static TypeQualifier	qualifierWithStatusAndType(boolean nodeStatus, java.lang.String type) Get an qualifier for the specified node status and type.

Methods inherited from class java.lang.Object

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

Constructor Detail

KindQualifier

public KindQualifier(java.lang.String newKind)

Creates new KindQualifier

Parameters:

newKind - The official element type of nodes to match (e.g. BPM.s_strType)

Method Detail

qualifierWithStatusAndType

public static TypeQualifier qualifierWithStatusAndType(boolean nodeStatus,
                                                       java.lang.String type)

Get an qualifier for the specified node status and type.

Parameters:

nodeStatus - the node status

type - the node type

Returns:

a qualifier restricted to both the status and type specified

match

public boolean match(AcceleratorNode node)

Determine if the specified node is a match based on this qualifier's criteria

Specified by:

match in interface TypeQualifier

Parameters:

node - The node to test

Returns:

true if the node is a match and false if not