edu.cmu.tetradapp.model.KnowledgeEditable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tetrad-gui Show documentation
The newest version!
///////////////////////////////////////////////////////////////////////////////
// For information as to what this class does, see the Javadoc, below.       //
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,       //
// 2007, 2008, 2009, 2010, 2014, 2015, 2022 by Peter Spirtes, Richard        //
// Scheines, Joseph Ramsey, and Clark Glymour.                               //
//                                                                           //
// This program is free software; you can redistribute it and/or modify      //
// it under the terms of the GNU General Public License as published by      //
// the Free Software Foundation; either version 2 of the License, or         //
// (at your option) any later version.                                       //
//                                                                           //
// This program is distributed in the hope that it will be useful,           //
// but WITHOUT ANY WARRANTY; without even the implied warranty of            //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             //
// GNU General Public License for more details.                              //
//                                                                           //
// You should have received a copy of the GNU General Public License         //
// along with this program; if not, write to the Free Software               //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA //
///////////////////////////////////////////////////////////////////////////////

package edu.cmu.tetradapp.model;

import edu.cmu.tetrad.data.Knowledge;
import edu.cmu.tetrad.graph.Graph;

import java.util.List;

/**
 * Interface to indicate a class whose knowledge is capable of being edited by the knowledge editor.
 *
 * @author josephramsey
 * @version $Id: $Id
 */
public interface KnowledgeEditable {

    /**
     * getKnowledge.
     *
     * @return a copy of the knowledge for this class.
     */
    Knowledge getKnowledge();

    /**
     * Sets knowledge to a copy of the given object.
     *
     * @param knowledge the knowledge to set.
     */
    void setKnowledge(Knowledge knowledge);

    /**
     * getSourceGraph.
     *
     * @return the source graph. This will be used to arrange the graph in the knowledge editor in a recognizable way.
     */
    Graph getSourceGraph();

    /**
     * getVarNames.
     *
     * @return the variable names that the knowledge editor may use.
     */
    List getVarNames();
}