org.openepics.cable.model

Class CableName

java.lang.Object

org.openepics.cable.model.CableName

public class CableName
extends Object

This represents a name assigned to a cable instance.

Author:

Sunil Sah

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	NAME_NUMBER_MIN_LENGTH

Constructor Summary

Constructors

Constructor and Description
CableName(String name) Creates a new instance from a string.
CableName(String system, String subsystem, String cableClass, Integer seqNumber) Creates a new instance from attributes.

Method Summary

Modifier and Type	Method and Description
static String	asString(String system, String subsystem, String cableClass, Integer seqNumber) Returns the string representation of the given parameters as a cable name (example 12A012345).
boolean	equals(Object obj)
String	getCableClass()
Integer	getSeqNumber()
String	getSubsystem()
String	getSystem()
int	hashCode()
static boolean	isValidCableClass(String value) Returns true if the value represents a valid cable class
static boolean	isValidName(String name) Returns true if the given name is a valid representation of a cable name.
static boolean	isValidSubsystem(String value) Returns true if the value represents a valid subsystem.
static boolean	isValidSystem(String value) Returns true if the value represents a valid system.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME_NUMBER_MIN_LENGTH

public static final Integer NAME_NUMBER_MIN_LENGTH

Constructor Detail

CableName

public CableName(String name)

Creates a new instance from a string.

Parameters:

name - the string representation of the cable name

CableName

public CableName(String system,
                 String subsystem,
                 String cableClass,
                 Integer seqNumber)

Creates a new instance from attributes.

Parameters:

system - the system digit

subsystem - the subsystem digit

cableClass - the class letter

seqNumber - the sequential number

Method Detail

isValidName

public static boolean isValidName(String name)

Returns true if the given name is a valid representation of a cable name.

Parameters:

name - the name to check

Returns:

true if valid, else false

isValidSystem

public static boolean isValidSystem(String value)

Returns true if the value represents a valid system.

Parameters:

value - the value

Returns:

true if the value represents a valid system, else false

isValidSubsystem

public static boolean isValidSubsystem(String value)

Returns true if the value represents a valid subsystem.

Parameters:

value - the value

Returns:

true if the value represents a valid subsystem, else false

isValidCableClass

public static boolean isValidCableClass(String value)

Returns true if the value represents a valid cable class

Parameters:

value - the value

Returns:

true if the value represents a valid cable class, else false

getSystem

public String getSystem()

Returns:

the system digit

getSubsystem

public String getSubsystem()

Returns:

the subsystem digit

getCableClass

public String getCableClass()

Returns:

the class letter

getSeqNumber

public Integer getSeqNumber()

Returns:

the sequential number

asString

public static String asString(String system,
                              String subsystem,
                              String cableClass,
                              Integer seqNumber)

Returns the string representation of the given parameters as a cable name (example 12A012345).

Parameters:

system - the number system

subsystem - the number subsystem

cableClass - the number cable class

seqNumber - the sequential number

Returns:

the string representation

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object