mapss.dif.graph.hierarchy
Class HierarchyException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              mapss.dif.graph.hierarchy.HierarchyException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CyclicHierarchyException

public class HierarchyException
extends java.lang.RuntimeException

This exception can be thrown by the methods in Hierarchy class. In addition to the exception functionality this class provides checks for maintaining stability and consistency in Hierarchy classes.

Version:

$Id: HierarchyException.java 409 2007-05-13 19:47:16Z plishker $

Author:

Fuat Keceli, Chia-Jui Hsu

See Also:

Hierarchy, Serialized Form

Constructor Summary

HierarchyException(java.lang.String message)

Method Summary

static HierarchyException	checkConnection(mocgraph.Edge edge, Port port) Checks if an edge can be connected to a port.
static HierarchyException	checkConnection(Port superPort, Port subPort) Checks if two ports can be connected.
static HierarchyException	checkFlatten(Hierarchy hierarchy, mocgraph.Node node) Checks if a super node in a hierarchy can be flattened without creating any errors or inconsistencies.
static HierarchyException	checkPort(Hierarchy hierarchy, Port port) Checks if port is suitable for adding to a hierarchy object.
static HierarchyException	checkSuperNode(Hierarchy parent, Hierarchy child) Checks if a node can be defined as a super node in a hierarchy.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HierarchyException

public HierarchyException(java.lang.String message)

Parameters:

message - Error string which can be accessed using getMessage() method.

Method Detail

checkConnection

public static HierarchyException checkConnection(mocgraph.Edge edge,
                                                 Port port)

Checks if an edge can be connected to a port.

Returns an exception if any of the following statements is true:

• Super node that contains the port is not sink or source of the edge.
• Edge is already connected to another port on the same super node (or two ports in case of a self loop),
• Edge direction and port direction don't match (if port is directed). If edge is a self loop edge, both ports cannot have the same direction.

  Parameters:

  edge - Edge to be connected.

  port - Port to be connected.

  Returns:

  A HierarchyException if any of the above statements is true, null otherwise.

checkConnection

public static HierarchyException checkConnection(Port superPort,
                                                 Port subPort)

Checks if two ports can be connected.

Two ports can be connected only if their hierarchies are directly related (i.e. one is a super-hierarchy and the other one is a sub-hierarchy). Also directions of the ports should match.

Parameters:

superPort - Port in the super-hierarchy.

subPort - Port in the sub-hierarchy.

Returns:

A HierarchyException if any of the above statements is true, null otherwise.

checkFlatten

public static HierarchyException checkFlatten(Hierarchy hierarchy,
                                              mocgraph.Node node)

Checks if a super node in a hierarchy can be flattened without creating any errors or inconsistencies. Returns an exception if any of the following statements is true:

• If the super node is not present in its graphs,
• If child graph cannot be added to the parent graph (nodes or edges might return exceptions while adding - see Graph.addNode(mocgraph.Node) and Graph.addEdge(mocgraph.Edge)),
• If there are any unconnected ports in the child hierarchy.
• If a connection cannot be made in the underlying graph objects because of a missing node or edge,
• If any of the super nodes in the sub-hierarchy cannot be added to the parent hierarchy (see checkSuperNode(mapss.dif.graph.hierarchy.Hierarchy, mapss.dif.graph.hierarchy.Hierarchy)),

  Parameters:

  hierarchy - Parent hierarchy.

  node - Super node to be flattened.

  Returns:

  A HierarchyException if any of the above statements is true, null otherwise.

checkPort

public static HierarchyException checkPort(Hierarchy hierarchy,
                                           Port port)

Checks if port is suitable for adding to a hierarchy object.

Returns an exception if the name of the port already exists in the hierarchy that it is being added.

Parameters:

hierarchy - Hierarchy to which the port will be added.

port - Port to be added to the hierarchy.

Returns:

A HierarchyException if the name of the port already exists null otherwise.

checkSuperNode

public static HierarchyException checkSuperNode(Hierarchy parent,
                                                Hierarchy child)

Checks if a node can be defined as a super node in a hierarchy.

Returns an exception if any of the following statements is true:

• The name of the sub-hierarchy is already used in another sub-hierarchy,
• This connection causes a relational cycle. (In this case the exception will be of type CyclicHierarchyException.

Parameters:

parent - The hierarchy that contains the node.

child - Sub-hierarchy to be added.

Returns:

A HierarchyException if any of the above statements is true, null otherwise.