001/* Base interface for the computation of source nodes in a graph.
002
003 Copyright (c) 2003-2013 The University of Maryland. All rights reserved.
004 Permission is hereby granted, without written agreement and without
005 license or royalty fees, to use, copy, modify, and distribute this
006 software and its documentation for any purpose, provided that the above
007 copyright notice and the following two paragraphs appear in all copies
008 of this software.
009
010 IN NO EVENT SHALL THE UNIVERSITY OF MARYLAND BE LIABLE TO ANY PARTY
011 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
012 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
013 THE UNIVERSITY OF MARYLAND HAS BEEN ADVISED OF THE POSSIBILITY OF
014 SUCH DAMAGE.
015
016 THE UNIVERSITY OF MARYLAND SPECIFICALLY DISCLAIMS ANY WARRANTIES,
017 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
018 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
019 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
020 MARYLAND HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
021 ENHANCEMENTS, OR MODIFICATIONS.
022
023
024 */
025package ptolemy.graph.analysis.analyzer;
026
027import java.util.List;
028
029///////////////////////////////////////////////////////////////////
030//// SourceNodeAnalyzer
031
032/**
033 Base interface for the computation of source nodes in a graph.
034 <p>
035 @see ptolemy.graph.analysis.SourceNodeAnalysis
036 @since Ptolemy II 4.0
037 @Pt.ProposedRating Red (shahrooz)
038 @Pt.AcceptedRating Red (ssb)
039 @author Shahrooz Shahparnia
040 @version $Id$
041 */
042public interface SourceNodeAnalyzer extends GraphAnalyzer {
043    ///////////////////////////////////////////////////////////////////
044    ////                         public methods                    ////
045
046    /** Return the source nodes in the graph under analysis.
047     *  Each element of the list is a {@link ptolemy.graph.Node}.
048     *
049     *  @return Return the source nodes.
050     */
051    public List nodes();
052}