All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class edu.vt.marian.common.LinkDesc 

java.lang.Object
   |
   +----edu.vt.marian.common.LinkDesc
public class LinkDesc
extends Object
At the moment, we are only allowing a link description to consist of an exact description of a single link. Future implementations may allow link variables and link operators. A single link is fully described by specifying its type and describing the nodes at source end and sink end. In the current context, we know the description of the node at one end (the "target" end): that is the node described in the node portion of some InfoDesc. The node at the other end (the "key" end) is described by a further InfoDesc. Thus each member of the linkDesc Vector is composed of three elements:

See Also:
InfoDesc

Variable Index

o ANY_DIRECTION
o classID
o debug
Just for debugging
o direction
o INVALID_DIRECTION
The possible directions.
o keyDesc
o SINK_TO_SOURCE
o SOURCE_TO_SINK

Constructor Index

o LinkDesc(Debug)
Create a new null LinkDesc.
o LinkDesc(int, int, InfoDesc, Debug)
Create a new LinkDesc from full specifications.

Method Index

o getClassID()
o getDirection()
o getKeyDesc()
o isValid()
o isValidDirection(int)
A little utility.
o setClassID(int)
o setDirection(int)
o setKeyDesc(InfoDesc)

Variables

o debug 
 protected Debug debug
Just for debugging

o classID 
 protected int classID
o direction 
 protected int direction
o keyDesc 
 protected InfoDesc keyDesc
o INVALID_DIRECTION 
 public static final int INVALID_DIRECTION
The possible directions.

o SOURCE_TO_SINK 
 public static final int SOURCE_TO_SINK
o SINK_TO_SOURCE 
 public static final int SINK_TO_SOURCE
o ANY_DIRECTION 
 public static final int ANY_DIRECTION

Constructors

o LinkDesc 
 public LinkDesc(Debug d)
Create a new null LinkDesc.

Parameters:
d - -- the eternal Debug object.
o LinkDesc 
 public LinkDesc(int linkClID,
                 int dir,
                 InfoDesc key,
                 Debug d)
Create a new LinkDesc from full specifications.

Parameters:
linkClID - (possibly super-) class for matching links.
dir - direction for links to run.
key - InfoDesc for node at other end of link.
d - the eternal Debug object.

Methods

o isValid 
 public boolean isValid()
o isValidDirection 
 public static boolean isValidDirection(int dir)
A little utility.

o setClassID 
 public void setClassID(int linkClID)
o getClassID 
 public int getClassID()
o setDirection 
 public void setDirection(int dir)
o getDirection 
 public int getDirection()
o setKeyDesc 
 public void setKeyDesc(InfoDesc key)
o getKeyDesc 
 public InfoDesc getKeyDesc()

All Packages  Class Hierarchy  This Package  Previous  Next  Index