Package org.pentaho.di.core.logging

Class LoggingObject

java.lang.Object

org.pentaho.di.core.logging.LoggingObject

All Implemented Interfaces:

LoggingObjectInterface, LoggingObjectLifecycleInterface

public class LoggingObject
extends Object
implements LoggingObjectInterface

Constructor Summary

Constructors

Constructor	Description
LoggingObject(Object object)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getContainerObjectId()	Gets the execution container (Carte/DI server/BI Server) object id.
String	getFilename()	Gets the filename.
String	getLogChannelId()	Gets the log channel id.
LogLevel	getLogLevel()	Gets the logging level of the log channel of this logging object.
String	getObjectCopy()	Gets a string identifying a copy in a series of steps.
ObjectId	getObjectId()	Gets the object id in a repository.
String	getObjectName()	Gets the object name.
ObjectRevision	getObjectRevision()	Gets the objects revision in a repository.
LoggingObjectType	getObjectType()	Gets the object type.
LoggingObjectInterface	getParent()	Gets the parent.
Date	getRegistrationDate()	Gets the registration date of this logging object.
RepositoryDirectoryInterface	getRepositoryDirectory()	Gets the repository directory.
boolean	isForcingSeparateLogging()
boolean	isGatheringMetrics()	Gets the boolean value of whether or not this object is gathering kettle metrics during execution.
boolean	isLoggingObjectInUse()
void	setCarteObjectId(String carteObjectId)
void	setFilename(String filename)
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)	Enable of disable kettle metrics gathering during execution
void	setLogChannelId(String logChannelId)
void	setLoggingObjectInUse(boolean loggingObjectInUse)
void	setLogLevel(LogLevel logLevel)
void	setObjectCopy(String objectCopy)
void	setObjectId(ObjectId objectId)
void	setObjectName(String name)
void	setObjectRevision(ObjectRevision objectRevision)
void	setObjectType(LoggingObjectType objectType)
void	setParent(LoggingObjectInterface parent)
void	setRegistrationDate(Date registrationDate)
void	setRepositoryDirectory(RepositoryDirectory repositoryDirectory)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.core.logging.LoggingObjectLifecycleInterface

callAfterLog, callBeforeLog

Constructor Detail

LoggingObject

public LoggingObject(Object object)

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isLoggingObjectInUse

public boolean isLoggingObjectInUse()

Specified by:

isLoggingObjectInUse in interface LoggingObjectInterface

setLoggingObjectInUse

public void setLoggingObjectInUse(boolean loggingObjectInUse)

getObjectName

public String getObjectName()

Description copied from interface: LoggingObjectInterface

Gets the object name.

Specified by:

getObjectName in interface LoggingObjectInterface

Returns:

the name

setObjectName

public void setObjectName(String name)

Parameters:

name - the name to set

getRepositoryDirectory

public RepositoryDirectoryInterface getRepositoryDirectory()

Description copied from interface: LoggingObjectInterface

Gets the repository directory.

Specified by:

getRepositoryDirectory in interface LoggingObjectInterface

Returns:

the repositoryDirectory

setRepositoryDirectory

public void setRepositoryDirectory(RepositoryDirectory repositoryDirectory)

Parameters:

repositoryDirectory - the repositoryDirectory to set

getFilename

public String getFilename()

Description copied from interface: LoggingObjectInterface

Gets the filename.

Specified by:

getFilename in interface LoggingObjectInterface

Returns:

the filename

setFilename

public void setFilename(String filename)

Parameters:

filename - the filename to set

getObjectId

public ObjectId getObjectId()

Description copied from interface: LoggingObjectInterface

Gets the object id in a repository.

Specified by:

getObjectId in interface LoggingObjectInterface

Returns:

the objectId

setObjectId

public void setObjectId(ObjectId objectId)

Parameters:

objectId - the objectId to set

getObjectRevision

public ObjectRevision getObjectRevision()

Description copied from interface: LoggingObjectInterface

Gets the objects revision in a repository.

Specified by:

getObjectRevision in interface LoggingObjectInterface

Returns:

the objectRevision

setObjectRevision

public void setObjectRevision(ObjectRevision objectRevision)

Parameters:

objectRevision - the objectRevision to set

getLogChannelId

public String getLogChannelId()

Description copied from interface: LoggingObjectInterface

Gets the log channel id.

Specified by:

getLogChannelId in interface LoggingObjectInterface

Returns:

the id

setLogChannelId

public void setLogChannelId(String logChannelId)

Parameters:

id - the id to set

getParent

public LoggingObjectInterface getParent()

Description copied from interface: LoggingObjectInterface

Gets the parent.

Specified by:

getParent in interface LoggingObjectInterface

Returns:

the parent

setParent

public void setParent(LoggingObjectInterface parent)

Parameters:

parent - the parent to set

getObjectType

public LoggingObjectType getObjectType()

Description copied from interface: LoggingObjectInterface

Gets the object type.

Specified by:

getObjectType in interface LoggingObjectInterface

Returns:

the objectType

setObjectType

public void setObjectType(LoggingObjectType objectType)

Parameters:

objectType - the objectType to set

getObjectCopy

public String getObjectCopy()

Description copied from interface: LoggingObjectInterface

Gets a string identifying a copy in a series of steps.

Specified by:

getObjectCopy in interface LoggingObjectInterface

Returns:

the copy

setObjectCopy

public void setObjectCopy(String objectCopy)

Parameters:

copy - the copy to set

getLogLevel

public LogLevel getLogLevel()

Description copied from interface: LoggingObjectInterface

Gets the logging level of the log channel of this logging object.

Specified by:

getLogLevel in interface LoggingObjectInterface

Returns:

The logging level of the log channel of this logging object.

setLogLevel

public void setLogLevel(LogLevel logLevel)

getContainerObjectId

public String getContainerObjectId()

Description copied from interface: LoggingObjectInterface

Gets the execution container (Carte/DI server/BI Server) object id. We use this to see to which copy of the job/trans hierarchy this object belongs. If it is null, we assume that we are running a single copy in Spoon/Pan/Kitchen.

Specified by:

getContainerObjectId in interface LoggingObjectInterface

Returns:

the carteObjectId

setCarteObjectId

public void setCarteObjectId(String carteObjectId)

Parameters:

carteObjectId - the carteObjectId to set

getRegistrationDate

public Date getRegistrationDate()

Description copied from interface: LoggingObjectInterface

Gets the registration date of this logging object. Null if it's not registered.

Specified by:

getRegistrationDate in interface LoggingObjectInterface

Returns:

the registrationDate

setRegistrationDate

public void setRegistrationDate(Date registrationDate)

Parameters:

registrationDate - the registrationDate to set

isGatheringMetrics

public boolean isGatheringMetrics()

Description copied from interface: LoggingObjectInterface

Gets the boolean value of whether or not this object is gathering kettle metrics during execution.

Specified by:

isGatheringMetrics in interface LoggingObjectInterface

Returns:

the gatheringMetrics

setGatheringMetrics

public void setGatheringMetrics(boolean gatheringMetrics)

Description copied from interface: LoggingObjectInterface

Enable of disable kettle metrics gathering during execution

Specified by:

setGatheringMetrics in interface LoggingObjectInterface

Parameters:

gatheringMetrics - the gatheringMetrics to set

isForcingSeparateLogging

public boolean isForcingSeparateLogging()

Specified by:

isForcingSeparateLogging in interface LoggingObjectInterface

Returns:

the forcingSeparateLogging

setForcingSeparateLogging

public void setForcingSeparateLogging(boolean forcingSeparateLogging)

Description copied from interface: LoggingObjectInterface

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 LoggingObjectInterface

Parameters:

forcingSeparateLogging - the forcingSeparateLogging to set