Package edu.cmu.tetrad.util

Interface TetradLoggerConfig

All Superinterfaces:

Serializable, TetradSerializable

All Known Implementing Classes:

DefaultTetradLoggerConfig, TetradLogger.EmptyConfig

public interface TetradLoggerConfig
extends TetradSerializable

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.

Version:

$Id: $Id

Author:

Tyler Gibson

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TetradLoggerConfig.Event	Represents an event which is just an id and a description.

Method Summary

Modifier and Type	Method	Description
boolean	active()	States whether the config is active or not.
TetradLoggerConfig	copy()	Creates a copy of the TetradLoggerConfig object.
List<TetradLoggerConfig.Event>	getSupportedEvents()	Retrieves the list of supported events.
boolean	isEventActive(String id)	States whether the event associated with the given id is active, that is whether it should be logged or not.
void	setEventActive(String id, boolean active)	Sets whether the event associated with the given id is active or not.
String	toString()	Returns a string representation of the object.

Method Details

isEventActive

boolean isEventActive(String id)

States whether the event associated with the given id is active, that is whether it should be logged or not.

Parameters:

id - a String object

Returns:

a boolean

active

boolean active()

States whether the config is active or not. THe config is considered active if there is at least one active event.

Returns:

- true iff its active.

getSupportedEvents

List<TetradLoggerConfig.Event> getSupportedEvents()

Retrieves the list of supported events.

Returns:

the list of supported events

setEventActive

void setEventActive(String id,
 boolean active)

Sets whether the event associated with the given id is active or not.

Parameters:

id - a String object

active - a boolean

copy

TetradLoggerConfig copy()

Creates a copy of the TetradLoggerConfig object.

Returns:

a copy of the TetradLoggerConfig object

toString

String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

the string representation of the object