org.apache.maven.diagrams.connectors.classes.edge_source
Class AbstractEdgeSource

java.lang.Object
  extended by org.codehaus.plexus.logging.AbstractLogEnabled
      extended by org.apache.maven.diagrams.connectors.classes.edge_source.AbstractEdgeSource
All Implemented Interfaces:
EdgeSource, org.codehaus.plexus.logging.LogEnabled
Direct Known Subclasses:
AggregateEdgeSource, ImplementEdgeSource, InheritanceEdgeSource

public abstract class AbstractEdgeSource
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements EdgeSource


Nested Class Summary
protected static class AbstractEdgeSource.AddNodeStatus
           
 
Field Summary
 
Fields inherited from interface org.apache.maven.diagrams.connectors.classes.edge_source.EdgeSource
ROLE
 
Constructor Summary
AbstractEdgeSource()
           
 
Method Summary
 java.util.Set<ClassEdge> calculateEdges(java.util.Set<ClassNode> resultNodes)
          The method returns created edges.
protected abstract  AbstractEdgeSource.AddNodeStatus canAddNode(ClassNode node)
          The method obtains information what can be done with the given node (if it should be added to the graph or skipped (with all without its dependencies))
 void configure(FilterRepository a_filterRepository, ClassNodesRepository a_classNodesRepository, ClassesConnectorConfiguration a_configuration)
          Sets the main (dependent components) in one call.
protected abstract  java.util.List<ClassEdge> createOutgoingEdges(ClassNode sourceNode)
          Implementation of this method should prepare list of outgoing edges from the given node.
 ClassNodesRepository getClassNodesRepository()
           
 ClassesConnectorConfiguration getConfiguration()
           
 FilterRepository getFilterRepository()
           
 
Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractEdgeSource

public AbstractEdgeSource()
Method Detail

configure

public void configure(FilterRepository a_filterRepository,
                      ClassNodesRepository a_classNodesRepository,
                      ClassesConnectorConfiguration a_configuration)
Description copied from interface: EdgeSource
Sets the main (dependent components) in one call.

Specified by:
configure in interface EdgeSource

calculateEdges

public java.util.Set<ClassEdge> calculateEdges(java.util.Set<ClassNode> resultNodes)
Description copied from interface: EdgeSource
The method returns created edges. It can also add new nodes to "resultNodes"

Specified by:
calculateEdges in interface EdgeSource

createOutgoingEdges

protected abstract java.util.List<ClassEdge> createOutgoingEdges(ClassNode sourceNode)
Implementation of this method should prepare list of outgoing edges from the given node. The method shouldn't check if the target node already exists in the graph. The calculate edges method will check that depending on results of canAddNode method. The implementation can call

Parameters:
sourceNode - - node from that we need edges.
Returns:

canAddNode

protected abstract AbstractEdgeSource.AddNodeStatus canAddNode(ClassNode node)
The method obtains information what can be done with the given node (if it should be added to the graph or skipped (with all without its dependencies))

Parameters:
node -
Returns:

getFilterRepository

public FilterRepository getFilterRepository()
Specified by:
getFilterRepository in interface EdgeSource

getClassNodesRepository

public ClassNodesRepository getClassNodesRepository()
Specified by:
getClassNodesRepository in interface EdgeSource

getConfiguration

public ClassesConnectorConfiguration getConfiguration()
Specified by:
getConfiguration in interface EdgeSource


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.