Class STNUEdgeInt

java.lang.Object

it.univr.di.cstnu.graph.AbstractComponent

it.univr.di.cstnu.graph.AbstractEdge

it.univr.di.cstnu.graph.STNEdgeInt

it.univr.di.cstnu.graph.STNUEdgeInt

All Implemented Interfaces:

Component, Edge, STNEdge, STNUEdge, Serializable, Comparable<Component>

public class STNUEdgeInt
extends STNEdgeInt
implements STNUEdge

Implements STNUEdge interface using signed integer values.

Version:

$Rev: 1153 $

Author:

posenato

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface Edge

Edge.ConstraintType

Modifier and Type	Interface	Description
static enum	Edge.ConstraintType	Possible types of an edge.

Nested classes/interfaces inherited from interface STNEdge

STNEdge.EdgeValue<E>

Modifier and Type	Interface	Description
static interface	STNEdge.EdgeValue<E extends STNEdge>	Functional interface to retrieve the edge value of interest.

Nested classes/interfaces inherited from interface STNUEdge

STNUEdge.CaseLabel

Modifier and Type	Interface	Description
static class	STNUEdge.CaseLabel	A lower/upper-case label is represented as a pair: (node-name, flag).

Field Summary

Fields

Modifier and Type	Field	Description
(package private) STNUEdge.CaseLabel	caseLabel	The upper/lower case label.
(package private) int	labeledValue	The labeled value associated with the edge when it is a contingent link or a wait constraint.
static final long	serialVersionUID	Serial number

Fields inherited from class STNEdgeInt

value

Modifier and Type	Field	Description
(package private) int	value	the value associated with the edge

Fields inherited from class AbstractEdge

constraintType

Modifier and Type	Field	Description
(package private) Edge.ConstraintType	constraintType	The type of the edge.

Fields inherited from class AbstractComponent

name, pcs

Modifier and Type	Field	Description
(package private) String	name	Possible name
(package private) PropertyChangeSupport	pcs	Since Java 9, Observable has no longer been supported.

Fields inherited from interface STNUEdge

LC_LABEL, LOG, SEP_CASE, UC_LABEL

Modifier and Type	Field	Description
static final String	LC_LABEL	Constant LC_LABEL="LC"
static final Logger	LOG	logger
static final String	SEP_CASE	Constant SEP_CASE=":"
static final String	UC_LABEL	Constant UC_LABEL="UC"

Constructor Summary

Constructors

Constructor	Description
STNUEdgeInt()	Constructor for STNUEdgeInt.
STNUEdgeInt(Edge e)
STNUEdgeInt(String n)
STNUEdgeInt(String n, int v)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all components but the name.
STNUEdge.CaseLabel	getCaseLabel()
int	getLabeledValue()
boolean	hasSameValues(Edge e)
boolean	isEmpty()
boolean	isSTNEdge()	This method is inappropriate here, but it helps to speed up the code.
boolean	isSTNUEdge()	This method is inappropriate here, but it helps to speed up the code.
STNUEdgeInt	newInstance()	Factory
STNUEdgeInt	newInstance(Edge edge)	Any super-interfaces/implementing classes should ensure that such a method has the edge as an argument!
STNUEdgeInt	newInstance(String name1)	Factory
final int	resetLabeledValue()	Removes the labeled value and makes the edges an ordinary constraint if it was contingent.
final int	setLabeledValue(ALabelAlphabet.ALetter nodeALetter, int w, boolean upperCase)	Sets the labeled weight to w of a Edge.ConstraintType.contingent edge.
void	takeIn(Edge e)	A copy by reference of the internal structure of edge e.
final String	toString()	Return a string representation of labeled values.
boolean	updateValue(int v)	If the edge is not a wait, it sets the ordinary value if v is smaller than the current one.

Methods inherited from class STNEdgeInt

getValue, setValue, size

Modifier and Type	Method	Description
final int	getValue()
final int	setValue(int w)	Sets the weight to w.
int	size()

Methods inherited from class AbstractEdge

getConstraintType, getRoute, isCSTNEdge, isCSTNPSUEdge, isCSTNUEdge, isOSTNUEdge, setConstraintType, setName, setRoute

Modifier and Type	Method	Description
final Edge.ConstraintType	getConstraintType()
final EdgeRoute	getRoute()
boolean	isCSTNEdge()	This method is inappropriate here, but it helps to speed up the code.
boolean	isCSTNPSUEdge()	This method is inappropriate here, but it helps to speed up the code.
boolean	isCSTNUEdge()	This method is inappropriate here, but it helps to speed up the code.
boolean	isOSTNUEdge()	This method is inappropriate here, but it helps to speed up the code.
final void	setConstraintType(Edge.ConstraintType type)
final String	setName(String newName)	Sets the name of the edge.
final void	setRoute(EdgeRoute route1)	Sets the explicit routing of this edge, or null to return the edge to automatic.

Methods inherited from class AbstractComponent

addObserver, compareTo, equals, equalsByName, getName, hashCode, inNegativeCycle, isNameManagedByGraph, markNameManagedByGraph, removeObserver, renameInternal, setInNegativeCycle, takeIn

Modifier and Type	Method	Description
final void	addObserver(String propertyName, PropertyChangeListener l)	An observer for the property.
final int	compareTo(Component o)	Implements the natural order of the component names.
boolean	equals(Object o)	Deprecated.
final boolean	equalsByName(Component c)	A component is assumed to be equal to another if it has the same name.
final String	getName()
final int	hashCode()
final boolean	inNegativeCycle()
(package private) final boolean	isNameManagedByGraph()
(package private) final void	markNameManagedByGraph()	Locks AbstractComponent.setName(String).
final void	removeObserver(String propertyName, PropertyChangeListener listener)	Removes a specific listener
(package private) final void	renameInternal(String newName)	Sets the name without validation or notification.
final void	setInNegativeCycle(boolean isInNegativeCycle)	Sets true if the edge is in a negative cycle
final void	takeIn(Component c)

Methods inherited from class Object

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

Methods inherited from interface Edge

isContingentEdge, isRequirementEdge

Modifier and Type	Method	Description
default boolean	isContingentEdge()
default boolean	isRequirementEdge()

Methods inherited from interface STNUEdge

getLabeledValueFormatted, isLowerCase, isOrdinaryEdge, isUpperCase, isWait, setLabeledValue, setWait, updateWait

Modifier and Type	Method	Description
default String	getLabeledValueFormatted()	Representation of the labeled value as a string.
default boolean	isLowerCase()
default boolean	isOrdinaryEdge()
default boolean	isUpperCase()
default boolean	isWait()
default boolean	setLabeledValue(String labeledValueAsString)	Parses an upper/case labeled value to determine the new value for this edge.
default boolean	setWait(ALabelAlphabet.ALetter C, int w)	Sets this edge to be the wait C:w.
default boolean	updateWait(int waitValue, ALabelAlphabet.ALetter C)	If the edge is a wait, it sets the wait value if v is smaller than the current wait value.

Field Details

serialVersionUID

public static final long serialVersionUID

Serial number

See Also:

• Constant Field Values

labeledValue

int labeledValue

The labeled value associated with the edge when it is a contingent link or a wait constraint. Its value is Constants.INT_NULL when this edge is ordinary.

caseLabel

STNUEdge.CaseLabel caseLabel

The upper/lower case label.

The first component is the node label; the second specifies the nature: true for upper-case, false for lower-case.

Constructor Details

STNUEdgeInt

public STNUEdgeInt()

Constructor for STNUEdgeInt.

STNUEdgeInt

public STNUEdgeInt(Edge e)

Parameters:

e - a Edge object.

STNUEdgeInt

public STNUEdgeInt(String n)

Parameters:

n - a String object.

STNUEdgeInt

public STNUEdgeInt(String n,
 int v)

Parameters:

n - a String object.

v - the weight of the edge

Method Details

clear

public void clear()

Description copied from interface: Component

Clear all components but the name.

Specified by:

clear in interface Component

Overrides:

clear in class STNEdgeInt

getCaseLabel

public STNUEdge.CaseLabel getCaseLabel()

Specified by:

getCaseLabel in interface STNUEdge

Returns:

the node case label associated with this edge when it is a contingent or a wait one, null otherwise.

getLabeledValue

public int getLabeledValue()

Specified by:

getLabeledValue in interface STNUEdge

Returns:

the labeled weight if it is a contingent edge or a wait, Constants.INT_NULL otherwise.

hasSameValues

public boolean hasSameValues(Edge e)

Specified by:

hasSameValues in interface Edge

Overrides:

hasSameValues in class STNEdgeInt

Parameters:

e - the other edge

Returns:

true if it has the same values.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Edge

Overrides:

isEmpty in class STNEdgeInt

Returns:

true if it does not contain any values

isSTNEdge

public boolean isSTNEdge()

Description copied from interface: Edge

This method is inappropriate here, but it helps to speed up the code.

Specified by:

isSTNEdge in interface Edge

Overrides:

isSTNEdge in class STNEdgeInt

Returns:

true if the edge is an STN edge

isSTNUEdge

public boolean isSTNUEdge()

Description copied from interface: Edge

This method is inappropriate here, but it helps to speed up the code.

Specified by:

isSTNUEdge in interface Edge

Overrides:

isSTNUEdge in class AbstractEdge

Returns:

true if the edge is an STNU edge

newInstance

public STNUEdgeInt newInstance()

Description copied from interface: Edge

Factory

Specified by:

newInstance in interface Edge

Overrides:

newInstance in class STNEdgeInt

Returns:

an object of type Edge.

newInstance

public STNUEdgeInt newInstance(Edge edge)

Description copied from interface: Edge

Any super-interfaces/implementing classes should ensure that such a method has the edge as an argument!

Specified by:

newInstance in interface Edge

Overrides:

newInstance in class STNEdgeInt

Parameters:

edge - an object to clone.

Returns:

an object of type Edge.

newInstance

public STNUEdgeInt newInstance(String name1)

Description copied from interface: Edge

Factory

Specified by:

newInstance in interface Edge

Overrides:

newInstance in class STNEdgeInt

Parameters:

name1 - of the edge

Returns:

an object of type Edge.

resetLabeledValue

public final int resetLabeledValue()

Removes the labeled value and makes the edges an ordinary constraint if it was contingent.

Specified by:

resetLabeledValue in interface STNUEdge

Returns:

the old labeled value.

setLabeledValue

public final int setLabeledValue(ALabelAlphabet.ALetter nodeALetter,
 int w,
 boolean upperCase)

Description copied from interface: STNUEdge

Sets the labeled weight to w of a Edge.ConstraintType.contingent edge. If nodeLabel == null or w = Constants.INT_NULL, the possible labeled value is removed.

If a wait must be set, use STNUEdge.updateWait(int, ALetter).

Specified by:

setLabeledValue in interface STNUEdge

Parameters:

nodeALetter - the name of the contingent node as ALetter.

w - the new weight value

upperCase - true if the edge is an upper-case edge, false it is a lower-case edge. In the case of lower-case edge, w must be positive.

Returns:

the old weight associated with the edge. If the weight was not set, it returns Constants.INT_NULL.

takeIn

public void takeIn(Edge e)

Description copied from interface: Edge

A copy by reference of the internal structure of edge e.

Specified by:

takeIn in interface Edge

Overrides:

takeIn in class STNEdgeInt

Parameters:

e - edge to clone. If null, it does nothing.

toString

@Nonnull
public final String toString()

Description copied from class: AbstractComponent

Return a string representation of labeled values.

Specified by:

toString in interface Component

Overrides:

toString in class STNEdgeInt

Returns:

string representation of the edge

updateValue

public boolean updateValue(int v)

If the edge is not a wait, it sets the ordinary value if v is smaller than the current one. If the edge is a wait, it sets the ordinary value if v is negative. Moreover, if v is smaller (i.e., stronger) than the wait value, the wait is removed.

Specified by:

updateValue in interface STNEdge

Overrides:

updateValue in class STNEdgeInt

Parameters:

v - the new weight value

Returns:

true if the update occurred, false otherwise;