com.tensegrity.graph.model
Interface PortDenotation

All Superinterfaces:

Attributable, AttributableOnSet

public interface PortDenotation

extends AttributableOnSet

A PortDenotation is a meta-level class which encapusates the rules about incoming and outgoing connections to a Port. While a Port maintains an identifier unique to its Node owner, a PortDenotation maintains and returns a name which describes its connection role.

Version:

$Id: PortDenotation.java,v 1.13 2005/09/29 13:45:56 MichaelKegel Exp $

Author:

MichaelKegel

See Also:

Port

Field Summary

static int	PORTDENOTATION_FLAG_INPUT Flags that define properties of this port.
static int	PORTDENOTATION_FLAG_OUTPUT Flags that define properties of this port.

Fields inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

TREE_SUBSET_POSTFIX

Method Summary

PortDenotation	deepCopy() Returns a deep independent copy of this PortDenoation object.
int	getInputAcceptanceLevel()
int	getInputCardinality() Returns the input cardinality of the port. 0 means unlimited.
java.lang.String	getName() Returns the name for the PortDenotation.
int	getOutputAcceptanceLevel()
int	getOutputCardinality() Returns the output cardinality of the port. 0 means unlimited.
boolean	isHierarchicalPort() Returns a boolean that indicates whether the Port is visible within a hierarchy of Graph and Subgraph objects or if it is only visible in the context of a single Graph or Subgraph.
boolean	isInputPort() Returns true if the port can be used as an input port.
boolean	isOutputPort() Returns true if the port can be used as an output port.

Methods inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

addAttributableOnSetListener, areAttributableEventsEnabled, disableAttributableEvents, enableAttributableEvents, getAttributes, getAttributesTree, removeAttributableOnSetListener, setAttributes, setAttributesTree

Methods inherited from interface com.tensegrity.generic.attribute.Attributable

getAttribute, getAttributeType, getAttributeValue, setAttribute, setAttributeValue

Field Detail

PORTDENOTATION_FLAG_INPUT

public static final int PORTDENOTATION_FLAG_INPUT

Flags that define properties of this port.

See Also:

Constant Field Values

PORTDENOTATION_FLAG_OUTPUT

public static final int PORTDENOTATION_FLAG_OUTPUT

Flags that define properties of this port.

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

Returns the name for the PortDenotation. This name is also taken as name for the Port the PortDenotation is assigned to.

Returns:

String the name for the PortDenoation

Find more information in the class documentation

isHierarchicalPort

public boolean isHierarchicalPort()

Returns a boolean that indicates whether the Port is visible within a hierarchy of Graph and Subgraph objects or if it is only visible in the context of a single Graph or Subgraph.

Returns:

boolean flag that indicates whether the Port is visible in the complete hierarchy of Graph and Subgraph objects or not.

isInputPort

public boolean isInputPort()

Returns true if the port can be used as an input port.

Returns:

true if the port can be used as an input port.

Find more information in the class documentation

isOutputPort

public boolean isOutputPort()

Returns true if the port can be used as an output port.

Returns:

true if the port can be used as an output port.

Find more information in the class documentation

getInputCardinality

public int getInputCardinality()

Returns the input cardinality of the port. 0 means unlimited.

Returns:

the input cardinality of the port.

Find more information in the class documentation

getOutputCardinality

public int getOutputCardinality()

Returns the output cardinality of the port. 0 means unlimited.

Returns:

the output cardinality of the port.

Find more information in the class documentation

getInputAcceptanceLevel

public int getInputAcceptanceLevel()

getOutputAcceptanceLevel

public int getOutputAcceptanceLevel()

deepCopy

public PortDenotation deepCopy()

Returns a deep independent copy of this PortDenoation object.

Returns:

a deep independent copy of this PortDenoation object.