org.eigenbase.trace
Class EigenbaseTrace

java.lang.Object
  org.eigenbase.trace.EigenbaseTrace

public abstract class EigenbaseTrace
extends Object

Contains all of the tracers used within org.eigenbase class libraries.

Note to developers

Please ensure that every tracer used in org.eigenbase is added to this class as a public static final member called componentTracer. For example, getPlannerTracer() is the tracer used by all classes which take part in the query planning process.

The javadoc in this file is the primary source of information on what tracers are available, so the javadoc against each tracer member must be an up-to-date description of what that tracer does. Be sure to describe what tracing level is required to obtain each category of tracing.

In the class where the tracer is used, create a private (or perhaps protected) static final member called tracer.

Since:

May 24, 2004

Version:

$Id: //open/dev/farrago/src/org/eigenbase/trace/EigenbaseTrace.java#18 $

Author:

jhyde

Field Summary

static Logger

parserTracer The "org.eigenbase.sql.parser" tracer reports parser events in SqlParser and other classes (at level Level.FINE or higher).

Constructor Summary

EigenbaseTrace()

Method Summary

static Logger	getClassMapTracer() The "org.eigenbase.oj.util.OJClassMap" tracer reports when synthetic classes are created (Level.FINE)
static Logger	getCompoundIteratorTracer() The "org.eigenbase.runtime.CompoundIterator" tracer traces CompoundIterator: Level.FINE shows the transition to the next child Iterator.
static Logger	getJmiChangeSetTracer() The "org.eigenbase.jmi.JmiChangeSet" tracer reports JmiChangeSet events.
static Logger	getParserTracer() The "org.eigenbase.sql.parser" tracer reports parse events.
static Logger	getPlannerTracer() The "org.eigenbase.relopt.RelOptPlanner" tracer prints the query optimization process.
static Logger	getPropertyTracer() The "org.eigenbase.util.property.Property" tracer reports errors related to all manner of properties.
static Logger	getRelImplementorTracer() The "org.eigenbase.oj.rel.JavaRelImplementor" tracer reports when expressions are bound to variables (Level.FINE)
static Logger	getSqlTimingTracer() The tracer "org.eigenbase.sql.timing" traces timing for various stages of query processing.
static Logger	getSqlToRelTracer() The "org.eigenbase.sql2rel" tracer reports parse events.
static Logger	getStatementTracer() The "org.eigenbase.oj.stmt.OJPreparingStmt" tracer prints the generated program at level Level.FINE or higher.

Methods inherited from class java.lang.Object

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

Field Detail

parserTracer

public static final Logger parserTracer

The "org.eigenbase.sql.parser" tracer reports parser events in SqlParser and other classes (at level Level.FINE or higher).

Constructor Detail

EigenbaseTrace

public EigenbaseTrace()

Method Detail

getPlannerTracer

public static Logger getPlannerTracer()

The "org.eigenbase.relopt.RelOptPlanner" tracer prints the query optimization process.

Levels:

• Level.FINE prints rules as they fire;
• Level.FINER prints and validates the whole expression pool and rule queue as each rule fires;
• Level.FINEST prints finer details like rule importances.

getStatementTracer

public static Logger getStatementTracer()

The "org.eigenbase.oj.stmt.OJPreparingStmt" tracer prints the generated program at level Level.FINE or higher.

getRelImplementorTracer

public static Logger getRelImplementorTracer()

The "org.eigenbase.oj.rel.JavaRelImplementor" tracer reports when expressions are bound to variables (Level.FINE)

getSqlTimingTracer

public static Logger getSqlTimingTracer()

The tracer "org.eigenbase.sql.timing" traces timing for various stages of query processing.

See Also:

EigenbaseTimingTracer

getParserTracer

public static Logger getParserTracer()

The "org.eigenbase.sql.parser" tracer reports parse events.

getSqlToRelTracer

public static Logger getSqlToRelTracer()

The "org.eigenbase.sql2rel" tracer reports parse events.

getJmiChangeSetTracer

public static Logger getJmiChangeSetTracer()

The "org.eigenbase.jmi.JmiChangeSet" tracer reports JmiChangeSet events.

getClassMapTracer

public static Logger getClassMapTracer()

The "org.eigenbase.oj.util.OJClassMap" tracer reports when synthetic classes are created (Level.FINE)

getPropertyTracer

public static Logger getPropertyTracer()

The "org.eigenbase.util.property.Property" tracer reports errors related to all manner of properties.

getCompoundIteratorTracer

public static Logger getCompoundIteratorTracer()

The "org.eigenbase.runtime.CompoundIterator" tracer traces CompoundIterator:

• Level.FINE shows the transition to the next child Iterator.
• Level.FINER shows every element.