edu.cmu.tetrad.util.TetradLoggerConfig Maven / Gradle / Ivy
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.tetrad.util;
import java.util.List;
/**
* Represents the configuration for the logger. The idea is that each model has its own logger configuration, which is
* merely the events that the model supports.
*
* @author Tyler Gibson
* @version $Id: $Id
*/
public interface TetradLoggerConfig extends TetradSerializable {
/**
* States whether the event associated with the given id is active, that is whether it should be logged or not.
*
* @param id a {@link java.lang.String} object
* @return a boolean
*/
boolean isEventActive(String id);
/**
* States whether the config is active or not. THe config is considered active if there is at least one active
* event.
*
* @return - true iff its active.
*/
boolean active();
/**
* Retrieves the list of supported events.
*
* @return the list of supported events
*/
List getSupportedEvents();
/**
* Sets whether the event associated with the given id is active or not.
*
* @param id a {@link java.lang.String} object
* @param active a boolean
*/
void setEventActive(String id, boolean active);
/**
* Creates a copy of the TetradLoggerConfig object.
*
* @return a copy of the TetradLoggerConfig object
*/
TetradLoggerConfig copy();
/**
* Returns a string representation of the object.
*
* @return the string representation of the object
*/
String toString();
/**
* Represents an event which is just an id and a description.
*/
interface Event extends TetradSerializable {
/**
* Returns the ID of the event.
*
* @return the ID of the event
*/
String getId();
/**
* Returns the description of the event.
*
* @return the description of the event
*/
String getDescription();
}
}