ptolemy.graph.analysis
Class SinkNodeAnalysis

java.lang.Object
  ptolemy.graph.analysis.Analysis
      ptolemy.graph.analysis.SinkNodeAnalysis

public class SinkNodeAnalysis
extends Analysis

Computation of sink nodes in a graph. A sink node in a graph is a node without output edges.

The returned collection cannot be modified when the client uses the default strategy.

Since:

Ptolemy II 2.0

Version:

$Id: SinkNodeAnalysis.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Shahrooz Shahparnia

Accepted Rating:

Red (ssb)

Proposed Rating:

Red (shahrooz)

Constructor Summary

SinkNodeAnalysis(Graph graph)
Construct an instance of this class for a given graph.

SinkNodeAnalysis(SinkNodeAnalyzer analyzer)
Construct an instance of this class using a given analyzer.

Method Summary

java.util.List	nodes() Return the sink nodes in the graph under analysis.
java.lang.String	toString() Return a description of the analysis and the associated analyzer.
boolean	validAnalyzerInterface(Analyzer analyzer) Check if a given analyzer is compatible with this analysis.

Methods inherited from class ptolemy.graph.analysis.Analysis

analyzer, changeAnalyzer, graph, valid

Methods inherited from class java.lang.Object

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

Constructor Detail

SinkNodeAnalysis

public SinkNodeAnalysis(Graph graph)

Construct an instance of this class for a given graph.

Parameters:

graph - The given graph.

SinkNodeAnalysis

public SinkNodeAnalysis(SinkNodeAnalyzer analyzer)

Construct an instance of this class using a given analyzer.

Parameters:

analyzer - The given analyzer.

Method Detail

nodes

public java.util.List nodes()

Return the sink nodes in the graph under analysis. Each element of the list is an Node.

Returns:

Return the sink nodes.

toString

public java.lang.String toString()

Return a description of the analysis and the associated analyzer.

Overrides:

toString in class Analysis

Returns:

A description of the analysis and the associated analyzer.

validAnalyzerInterface

public boolean validAnalyzerInterface(Analyzer analyzer)

Check if a given analyzer is compatible with this analysis. In other words if it is possible to use it to compute the computation associated with this analysis.

Overrides:

validAnalyzerInterface in class Analysis

Parameters:

analyzer - The given analyzer.

Returns:

True if the given analyzer is valid for this analysis.