info.pppc.base.system.nf

Class NFDimension

java.lang.Object

info.pppc.base.system.nf.NFDimension

All Implemented Interfaces:

ISerializable

public final class NFDimension
extends java.lang.Object
implements ISerializable

This class represents an nonfunctional attribute or dimension including a tolerance window and some more features. Instances of this class are used to represent individual requirements on the communication stack composition.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABBREVIATION The abbreviation used for this class during serialization.
static short	IDENTIFIER_ABILITY This is an identifier that denotes that the specified extension should have the specified ability.
static short	IDENTIFIER_GATEWAY This is an identifier that denotes whether routing should use gateways This dimension only supports hard values and the value must be a boolean set to true if gateways shall be used and false if gateways shall not be used.
static short	IDENTIFIER_REQUIRED This is a marker dimension that denotes that the specified extension is required.
static short	IDENTIFIER_TYPE This is an identifier that denotes a specific type.
static short	ORDERING_ASCENDING Constant that defines the ordering to be ascending.
static short	ORDERING_DESCENDING Constant that defines the ordering to be descending.

Constructor Summary

Constructors

Constructor and Description
NFDimension() This constructor is solely used during serialization, do not call this constructor from user code.
NFDimension(short identifier, java.lang.Object hardValue) Creates a dimension that is not ordered and that denotes a single hard value.
NFDimension(short identifier, short orientation, java.lang.Object hardValue) Creates a dimension that is ordered with the specified orientation and a single hard value.
NFDimension(short identifier, short orientation, java.lang.Object hardValue, java.lang.Object softValue) Creates a dimension that is ordered with the specified orientation under the specified hard and soft value.

Method Summary

Methods

Modifier and Type	Method and Description
NFDimension	copy() Creates a copy of this dimension.
java.lang.Object	getHardValue() Returns the hard value.
short	getIdentifier() Returns the identifier of the dimension.
int	getOrientation() Returns the orientation of the dimension.
java.lang.Object	getSoftValue() Returns the soft value.
boolean	isOrdered() Returns if the dimension is ordered.
void	readObject(IObjectInput input) Deserializes the object from the stream.
java.lang.String	toString() Returns a string representation of this dimension.
void	writeObject(IObjectOutput output) Serializes the object to the stream.

Methods inherited from class java.lang.Object

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

Field Detail

ABBREVIATION

public static final java.lang.String ABBREVIATION

The abbreviation used for this class during serialization.

See Also:

Constant Field Values

IDENTIFIER_REQUIRED

public static final short IDENTIFIER_REQUIRED

This is a marker dimension that denotes that the specified extension is required. The values of this dimension are booleans. If the hard value is true, the extension is required (i.e., no valid communication session can be created without the extension). If the hard value is false and the soft value is true, the selection strategy decides whether the extension can be created.

See Also:

Constant Field Values

IDENTIFIER_ABILITY

public static final short IDENTIFIER_ABILITY

This is an identifier that denotes that the specified extension should have the specified ability. The value objects are shorts, just like any ability. This dimension does only support a hard value.

See Also:

Constant Field Values

IDENTIFIER_TYPE

public static final short IDENTIFIER_TYPE

This is an identifier that denotes a specific type. At the present time this is solely used as part of semantic plug-ins. The only values supported are the short value 0 to denote a synchronous invocation and the short value 1 to denote asynchronous invocations. This value denotes a remote invocation. This dimension does only support a hard value.

See Also:

Constant Field Values

IDENTIFIER_GATEWAY

public static final short IDENTIFIER_GATEWAY

This is an identifier that denotes whether routing should use gateways This dimension only supports hard values and the value must be a boolean set to true if gateways shall be used and false if gateways shall not be used.

See Also:

Constant Field Values

ORDERING_ASCENDING

public static final short ORDERING_ASCENDING

Constant that defines the ordering to be ascending. Ascending means that a larger value is better.

See Also:

Constant Field Values

ORDERING_DESCENDING

public static final short ORDERING_DESCENDING

Constant that defines the ordering to be descending. Descending means that a smaller value is better.

See Also:

Constant Field Values

Constructor Detail

NFDimension

public NFDimension()

This constructor is solely used during serialization, do not call this constructor from user code.

NFDimension

public NFDimension(short identifier,
           java.lang.Object hardValue)

Creates a dimension that is not ordered and that denotes a single hard value. This is the simplest form of a dimension. It states "this value must be set" for this dimension identifier.

Parameters:

identifier - The id of the dimension.

hardValue - The value of this dimension.

NFDimension

public NFDimension(short identifier,
           short orientation,
           java.lang.Object hardValue)

Creates a dimension that is ordered with the specified orientation and a single hard value. This form of dimension denotes that "a value must be less than the specified hard value" (descending) or "more than the specified hard value" (ascending).

Parameters:

identifier - The identifier of the dimension.

hardValue - The hard value of the dimension.

orientation - The orientation of the dimension. The orientation must either be ascending or descending.

NFDimension

public NFDimension(short identifier,
           short orientation,
           java.lang.Object hardValue,
           java.lang.Object softValue)

Creates a dimension that is ordered with the specified orientation under the specified hard and soft value. This form of dimension denotes that "a value must be less than the specified hard value and the soft value would be best fit" (descending) or "more than the specified hard value and the soft value would be best fit" (ascending).

Parameters:

identifier - The identifier of the dimension.

hardValue - The hard value of the dimension.

orientation - The orientation of the dimension.

softValue - The soft value of the dimension.

Method Detail

getIdentifier

public short getIdentifier()

Returns the identifier of the dimension.

Returns:

The identifier of the dimension.

isOrdered

public boolean isOrdered()

Returns if the dimension is ordered.

Returns:

True, if ordered, else false.

getHardValue

public java.lang.Object getHardValue()

Returns the hard value.

Returns:

The hard value.

getOrientation

public int getOrientation()

Returns the orientation of the dimension. See static constants of the class for possible values.

Returns:

The orientation.

getSoftValue

public java.lang.Object getSoftValue()

Returns the soft value.

Returns:

The soft value.

readObject

public void readObject(IObjectInput input)
                throws java.io.IOException

Deserializes the object from the stream.

Specified by:

readObject in interface ISerializable

Parameters:

input - The input to read from.

Throws:

java.io.IOException - Thrown if the deserialization failed.

writeObject

public void writeObject(IObjectOutput output)
                 throws java.io.IOException

Serializes the object to the stream.

Specified by:

writeObject in interface ISerializable

Parameters:

output - The output to write to.

Throws:

java.io.IOException - Thrown if the serialization failed.

copy

public NFDimension copy()

Creates a copy of this dimension. The parameters are assumed to be immutable and thus they are not copied.

Returns:

A copy of this dimension.

toString

public java.lang.String toString()

Returns a string representation of this dimension.

Overrides:

toString in class java.lang.Object

Returns:

A string representation.