mobi.narf.recognition.configuration

Class LinkConfiguration

java.lang.Object

mobi.narf.recognition.configuration.LinkConfiguration

public final class LinkConfiguration
extends java.lang.Object

This class represent a directional link between two ports of two components. The link is represented as a reference to the components with two port names. This class is immutable.

Author:

Mac

Field Summary

Fields

Modifier and Type	Field and Description
static char	DYNAMIC_DELIMITER The delimiter between the dynamic port targets.

Constructor Summary

Constructors

Constructor and Description
LinkConfiguration(java.lang.String sourceComponent, java.lang.String sourcePort, java.lang.String targetComponent, java.lang.String targetPort) Creates a new link between the source and the target ports.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines whether this link equals another object.
java.lang.String	getSourceComponent() Returns the name of the source component that emits events.
java.lang.String	getSourcePort() Returns the source port that emits events.
java.lang.String	getSourcePrefix() Returns the port prefix for a dynamic source port or null if the source port is not a dynamic link.
java.lang.String	getSourceSuffix() Returns the port suffix for a dynamic source port or null if the source port is not a dynamic link.
java.lang.String	getTargetComponent() Returns the name of the target component that receives events.
java.lang.String	getTargetPort() Returns the target port that receives events.
java.lang.String	getTargetPrefix() Returns the port prefix for a dynamic target port or null if the target port is not a dynamic link.
java.lang.String	getTargetSuffix() Returns the port suffix for a dynamic target port or null if the target port is not a dynamic link.
int	hashCode() Computes a hash code for the object based on the values of the fields.
boolean	isSourceDynamic() Determines whether the source port refers to a dynamic port.
boolean	isTargetDynamic() Determines whether the target port refers to a dynamic port.
java.lang.String	toString() Returns a human readable string representation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DYNAMIC_DELIMITER

public static final char DYNAMIC_DELIMITER

The delimiter between the dynamic port targets.

See Also:

Constant Field Values

Constructor Detail

LinkConfiguration

public LinkConfiguration(java.lang.String sourceComponent,
                 java.lang.String sourcePort,
                 java.lang.String targetComponent,
                 java.lang.String targetPort)

Creates a new link between the source and the target ports.

Parameters:

sourceComponent - The source component name.

targetComponent - The target component name.

sourcePort - The source port name that emits events.

targetPort - The target port name that receives events.

Throws:

java.lang.NullPointerException - Thrown if the source port or component or target port or component are null.

Method Detail

getSourceComponent

public java.lang.String getSourceComponent()

Returns the name of the source component that emits events.

Returns:

The name of the source component that emits events.

getTargetComponent

public java.lang.String getTargetComponent()

Returns the name of the target component that receives events.

Returns:

The name of the target component that receives events.

getSourcePort

public java.lang.String getSourcePort()

Returns the source port that emits events.

Returns:

The source port that emits events.

getTargetPort

public java.lang.String getTargetPort()

Returns the target port that receives events.

Returns:

The target port that receives events.

getSourcePrefix

public java.lang.String getSourcePrefix()

Returns the port prefix for a dynamic source port or null if the source port is not a dynamic link.

Returns:

The port prefix, i.e. the name of the dynamic port that is linked as the source.

getSourceSuffix

public java.lang.String getSourceSuffix()

Returns the port suffix for a dynamic source port or null if the source port is not a dynamic link.

Returns:

The port suffix, i.e. the internal name of the dynamic link for the source.

getTargetPrefix

public java.lang.String getTargetPrefix()

Returns the port prefix for a dynamic target port or null if the target port is not a dynamic link.

Returns:

The port prefix, i.e. the name of the dynamic port that is linked as the target.

getTargetSuffix

public java.lang.String getTargetSuffix()

Returns the port suffix for a dynamic target port or null if the target port is not a dynamic link.

Returns:

The port suffix, i.e. the internal name of the dynamic link for the target.

isTargetDynamic

public boolean isTargetDynamic()

Determines whether the target port refers to a dynamic port.

Returns:

True if it refers to a dynamic port, false otherwise.

isSourceDynamic

public boolean isSourceDynamic()

Determines whether the source port refers to a dynamic port.

Returns:

True if it refers to a dynamic port, false otherwise.

equals

public boolean equals(java.lang.Object obj)

Determines whether this link equals another object. This is based on matching the source and target fields.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to match.

Returns:

True if the object equals the link.

hashCode

public int hashCode()

Computes a hash code for the object based on the values of the fields.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code for the parameter.

toString

public java.lang.String toString()

Returns a human readable string representation.

Overrides:

toString in class java.lang.Object

Returns:

A human readable string representation.