Package org.pentaho.di.core.logging

Class LogChannel

java.lang.Object

org.pentaho.di.core.logging.LogChannel

All Implemented Interfaces:

LogChannelInterface

public class LogChannel
extends Object
implements LogChannelInterface

Field Summary

Fields

Modifier and Type	Field	Description
static final LogChannelInterface	GENERAL
static final String	GENERAL_SUBJECT
static final String	GUI_SUBJECT
static final LogChannelInterface	METADATA
static final String	METADATA_SUBJECT
static final LogChannelInterface	UI

Constructor Summary

Constructors

Constructor	Description
LogChannel()
LogChannel(Object subject)
LogChannel(Object subject, boolean gatheringMetrics)
LogChannel(Object subject, boolean gatheringMetrics, boolean isPurgeable)
LogChannel(Object subject, LoggingObjectInterface parentObject)
LogChannel(Object subject, LoggingObjectInterface parentObject, boolean gatheringMetrics)

Method Summary

Modifier and Type	Method	Description
String	getContainerObjectId()
String	getFilter()
LoggingObjectLifecycleInterface	getHooks()
String	getLogChannelId()
LogLevel	getLogLevel()
boolean	isBasic()
boolean	isDebug()
boolean	isDetailed()
boolean	isError()
boolean	isForcingSeparateLogging()
boolean	isGatheringMetrics()
boolean	isRowLevel()
void	logBasic(String s)
void	logBasic(String s, Object... arguments)
void	logDebug(String s)
void	logDebug(String message, Object... arguments)
void	logDetailed(String s)
void	logDetailed(String s, Object... arguments)
void	logError(String s)
void	logError(String s, Object... arguments)
void	logError(String s, Throwable e)
void	logMinimal(String s)
void	logMinimal(String message, Object... arguments)
void	logRowlevel(String s)
void	logRowlevel(String message, Object... arguments)
void	println(LogMessageInterface message, Throwable e, LogLevel channelLogLevel)
void	println(LogMessageInterface logMessage, LogLevel channelLogLevel)
void	setContainerObjectId(String containerObjectId)
void	setFilter(String filter)
void	setForcingSeparateLogging(boolean forcingSeparateLogging)	This option will force the create of a separate logging channel even if the logging concerns identical objects with identical names.
void	setGatheringMetrics(boolean gatheringMetrics)
void	setHooks(LoggingObjectLifecycleInterface loggingObjectLifecycleInterface)
void	setLogLevel(LogLevel logLevel)
void	snap(MetricsInterface metric, long... value)	Add a snapshot to the metrics system for this log channel at the time of invocation.
void	snap(MetricsInterface metric, String subject, long... value)	Add a maximum snapshot to the metrics system for this log channel at the time of invocation.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

GENERAL_SUBJECT

public static final String GENERAL_SUBJECT

See Also:

• Constant Field Values

METADATA_SUBJECT

public static final String METADATA_SUBJECT

See Also:

• Constant Field Values

GUI_SUBJECT

public static final String GUI_SUBJECT

See Also:

• Constant Field Values

GENERAL

public static final LogChannelInterface GENERAL

METADATA

public static final LogChannelInterface METADATA

UI

public static final LogChannelInterface UI

Constructor Details

LogChannel

public LogChannel()

LogChannel

public LogChannel(Object subject)

LogChannel

public LogChannel(Object subject,
 boolean gatheringMetrics)

LogChannel

public LogChannel(Object subject,
 boolean gatheringMetrics,
 boolean isPurgeable)

LogChannel

public LogChannel(Object subject,
 LoggingObjectInterface parentObject)

LogChannel

public LogChannel(Object subject,
 LoggingObjectInterface parentObject,
 boolean gatheringMetrics)

Method Details

toString

public String toString()

Overrides:

toString in class Object

getLogChannelId

public String getLogChannelId()

Specified by:

getLogChannelId in interface LogChannelInterface

Returns:

the id of the logging channel

println

public void println(LogMessageInterface logMessage,
 LogLevel channelLogLevel)

println

public void println(LogMessageInterface message,
 Throwable e,
 LogLevel channelLogLevel)

logMinimal

public void logMinimal(String s)

Specified by:

logMinimal in interface LogChannelInterface

logBasic

public void logBasic(String s)

Specified by:

logBasic in interface LogChannelInterface

logError

public void logError(String s)

Specified by:

logError in interface LogChannelInterface

logError

public void logError(String s,
 Throwable e)

Specified by:

logError in interface LogChannelInterface

logBasic

public void logBasic(String s,
 Object... arguments)

Specified by:

logBasic in interface LogChannelInterface

logDetailed

public void logDetailed(String s,
 Object... arguments)

Specified by:

logDetailed in interface LogChannelInterface

logError

public void logError(String s,
 Object... arguments)

Specified by:

logError in interface LogChannelInterface

logDetailed

public void logDetailed(String s)

Specified by:

logDetailed in interface LogChannelInterface

logDebug

public void logDebug(String s)

Specified by:

logDebug in interface LogChannelInterface

logDebug

public void logDebug(String message,
 Object... arguments)

Specified by:

logDebug in interface LogChannelInterface

logRowlevel

public void logRowlevel(String s)

Specified by:

logRowlevel in interface LogChannelInterface

logMinimal

public void logMinimal(String message,
 Object... arguments)

Specified by:

logMinimal in interface LogChannelInterface

logRowlevel

public void logRowlevel(String message,
 Object... arguments)

Specified by:

logRowlevel in interface LogChannelInterface

isBasic

public boolean isBasic()

Specified by:

isBasic in interface LogChannelInterface

isDebug

public boolean isDebug()

Specified by:

isDebug in interface LogChannelInterface

isDetailed

public boolean isDetailed()

Specified by:

isDetailed in interface LogChannelInterface

isRowLevel

public boolean isRowLevel()

Specified by:

isRowLevel in interface LogChannelInterface

isError

public boolean isError()

Specified by:

isError in interface LogChannelInterface

getLogLevel

public LogLevel getLogLevel()

Specified by:

getLogLevel in interface LogChannelInterface

setLogLevel

public void setLogLevel(LogLevel logLevel)

Specified by:

setLogLevel in interface LogChannelInterface

getContainerObjectId

public String getContainerObjectId()

Specified by:

getContainerObjectId in interface LogChannelInterface

Returns:

the containerObjectId

setContainerObjectId

public void setContainerObjectId(String containerObjectId)

Specified by:

setContainerObjectId in interface LogChannelInterface

Parameters:

containerObjectId - the containerObjectId to set

isGatheringMetrics

public boolean isGatheringMetrics()

Specified by:

isGatheringMetrics in interface LogChannelInterface

Returns:

the gatheringMetrics

setGatheringMetrics

public void setGatheringMetrics(boolean gatheringMetrics)

Specified by:

setGatheringMetrics in interface LogChannelInterface

Parameters:

gatheringMetrics - the gatheringMetrics to set

isForcingSeparateLogging

public boolean isForcingSeparateLogging()

Specified by:

isForcingSeparateLogging in interface LogChannelInterface

Returns:

True if the logging is forcibly separated out from even identical objects.

setForcingSeparateLogging

public void setForcingSeparateLogging(boolean forcingSeparateLogging)

Description copied from interface: LogChannelInterface

This option will force the create of a separate logging channel even if the logging concerns identical objects with identical names.

Specified by:

setForcingSeparateLogging in interface LogChannelInterface

Parameters:

forcingSeparateLogging - Set to true to force separate logging

snap

public void snap(MetricsInterface metric,
 long... value)

Description copied from interface: LogChannelInterface

Add a snapshot to the metrics system for this log channel at the time of invocation. This will process the value depending on the type of metric specified. For example, for MetricsInterface.look up the maximum value in the metrics and replace it if the new value is higher. The snapshot date will be retained in that case.

Specified by:

snap in interface LogChannelInterface

Parameters:

metric - The metric to use (ex. connect to a database)

value - the value to store

snap

public void snap(MetricsInterface metric,
 String subject,
 long... value)

Description copied from interface: LogChannelInterface

Add a maximum snapshot to the metrics system for this log channel at the time of invocation. This will look up the maximum value in the metrics and replace it if the new value is higher. The snapshot date will be retained in that case.

Specified by:

snap in interface LogChannelInterface

Parameters:

metric - The metric to use (ex. connect to a database)

subject - The subject (ex. the name of the database)

value - the value to store

getFilter

public String getFilter()

Specified by:

getFilter in interface LogChannelInterface

setFilter

public void setFilter(String filter)

Specified by:

setFilter in interface LogChannelInterface

getHooks

public LoggingObjectLifecycleInterface getHooks()

Specified by:

getHooks in interface LogChannelInterface

setHooks

public void setHooks(LoggingObjectLifecycleInterface loggingObjectLifecycleInterface)

Specified by:

setHooks in interface LogChannelInterface