Class NamingProtocol

java.lang.Object

edu.cmu.tetrad.util.NamingProtocol

public final class NamingProtocol
extends Object

Specifies the protocol used in Tetrad for variable names.

Method Summary

Modifier and Type	Method	Description
static String	getProtocolDescription()	Provides a description of the naming protocol used for variable names.
static boolean	isLegalName(String name)	Evaluates whether the given name conforms to the naming protocol.

Methods inherited from class Object

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

Method Details

isLegalName

public static boolean isLegalName(String name)

Evaluates whether the given name conforms to the naming protocol.

Parameters:

name - the name to be checked

Returns:

true if the name is non-null and matches the pattern for legal names, false otherwise

getProtocolDescription

public static String getProtocolDescription()

Provides a description of the naming protocol used for variable names. The protocol specifies that names must begin with a non-numeric character, and may not contain spaces or tabs. Quotes are allowed within names.

Returns:

a string describing the rules for variable names in the naming protocol