org.pentaho.di.core.logging

Class JobLogTable

java.lang.Object

org.pentaho.di.core.logging.BaseLogTable

org.pentaho.di.core.logging.JobLogTable

All Implemented Interfaces:

Cloneable, LogTableCoreInterface, LogTableInterface

public class JobLogTable
extends BaseLogTable
implements Cloneable, LogTableInterface

This class describes a job logging table

Author:

matt

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobLogTable.ID

Field Summary

Fields

Modifier and Type	Field and Description
static String	XML_TAG

Fields inherited from class org.pentaho.di.core.logging.BaseLogTable

connectionName, databasesInterface, fields, PROP_LOG_TABLE_CONNECTION_NAME, PROP_LOG_TABLE_FIELD_ENABLED, PROP_LOG_TABLE_FIELD_ID, PROP_LOG_TABLE_FIELD_NAME, PROP_LOG_TABLE_FIELD_SUBJECT, PROP_LOG_TABLE_INTERVAL, PROP_LOG_TABLE_SCHEMA_NAME, PROP_LOG_TABLE_SIZE_LIMIT, PROP_LOG_TABLE_TABLE_NAME, PROP_LOG_TABLE_TIMEOUT_DAYS, schemaName, space, tableName, timeoutInDays

Method Summary

Modifier and Type	Method and Description
Object	clone()
LogTableField	findField(JobLogTable.ID id)
String	getConnectionNameVariable()
static JobLogTable	getDefault(VariableSpace space, HasDatabasesInterface databasesInterface)
String	getLogInterval() Get the logging interval in seconds.
RowMetaAndData	getLogRecord(LogStatus status, Object subject, Object parent) This method calculates all the values that are required
String	getLogSizeLimit()
String	getLogTableCode()
String	getLogTableType()
List<RowMetaInterface>	getRecommendedIndexes()
String	getSchemaNameVariable()
String	getStepnameInput()
String	getStepnameOutput()
String	getStepnameRead()
String	getStepnameRejected()
String	getStepnameUpdated()
String	getStepnameWritten()
Object	getSubject(JobLogTable.ID id)
String	getSubjectString(JobLogTable.ID id)
String	getTableNameVariable()
String	getXML()
boolean	isBatchIdUsed()
boolean	isLogFieldUsed()
void	loadFromRepository(RepositoryAttributeInterface attributeInterface)
void	loadXML(Node node, List<DatabaseMeta> databases, List<StepMeta> steps) Load the information for this logging table from the job XML node
void	replaceMeta(LogTableCoreInterface logTableInterface)
void	saveToRepository(RepositoryAttributeInterface attributeInterface) Save this core information of the log table to the repository using the specified attribute interface.
void	setAllGlobalParametersToNull()
void	setBatchIdUsed(boolean use)
void	setLogFieldUsed(boolean use)
void	setLogInterval(String logInterval) Sets the logging interval in seconds.
void	setLogSizeLimit(String logSizeLimit)

Methods inherited from class org.pentaho.di.core.logging.BaseLogTable

containsKeyField, equals, findField, getActualConnectionName, getActualSchemaName, getActualTableName, getConnectionName, getDatabaseMeta, getErrorsField, getFields, getFieldsXML, getKeyField, getLogBuffer, getLogDateField, getLogField, getNameField, getQuotedSchemaTableCombination, getSchemaName, getStatusField, getSubject, getSubjectString, getTableName, getTimeoutInDays, isDefined, isGlobalParameter, loadFieldsXML, replaceMeta, setConnectionName, setFields, setSchemaName, setTableName, setTimeoutInDays, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getActualSchemaName, getActualTableName, getConnectionName, getDatabaseMeta, getErrorsField, getFields, getKeyField, getLogDateField, getLogField, getNameField, getQuotedSchemaTableCombination, getSchemaName, getStatusField, getTableName, getTimeoutInDays, isDefined, setConnectionName

Field Detail

XML_TAG

public static final String XML_TAG

See Also:

Constant Field Values

Method Detail

clone

public Object clone()

Specified by:

clone in interface LogTableCoreInterface

Overrides:

clone in class BaseLogTable

getXML

public String getXML()

Specified by:

getXML in interface LogTableInterface

Returns:

The log table meta-data in XML format.

loadXML

public void loadXML(Node node,
                    List<DatabaseMeta> databases,
                    List<StepMeta> steps)

Description copied from interface: LogTableInterface

Load the information for this logging table from the job XML node

Specified by:

loadXML in interface LogTableInterface

Parameters:

node - the node to load from

databases - the list of database to reference.

steps - the steps to reference (or null)

saveToRepository

public void saveToRepository(RepositoryAttributeInterface attributeInterface)
                      throws KettleException

Description copied from class: BaseLogTable

Save this core information of the log table to the repository using the specified attribute interface.

Specified by:

saveToRepository in interface LogTableCoreInterface

Overrides:

saveToRepository in class BaseLogTable

Parameters:

attributeInterface - The attribute interface to use to set attributes

Throws:

KettleException

loadFromRepository

public void loadFromRepository(RepositoryAttributeInterface attributeInterface)
                        throws KettleException

Specified by:

loadFromRepository in interface LogTableCoreInterface

Overrides:

loadFromRepository in class BaseLogTable

Throws:

KettleException

replaceMeta

public void replaceMeta(LogTableCoreInterface logTableInterface)

Specified by:

replaceMeta in interface LogTableCoreInterface

getDefault

public static JobLogTable getDefault(VariableSpace space,
                                     HasDatabasesInterface databasesInterface)

findField

public LogTableField findField(JobLogTable.ID id)

getSubject

public Object getSubject(JobLogTable.ID id)

getSubjectString

public String getSubjectString(JobLogTable.ID id)

setBatchIdUsed

public void setBatchIdUsed(boolean use)

isBatchIdUsed

public boolean isBatchIdUsed()

setLogFieldUsed

public void setLogFieldUsed(boolean use)

isLogFieldUsed

public boolean isLogFieldUsed()

getStepnameRead

public String getStepnameRead()

getStepnameWritten

public String getStepnameWritten()

getStepnameInput

public String getStepnameInput()

getStepnameOutput

public String getStepnameOutput()

getStepnameUpdated

public String getStepnameUpdated()

getStepnameRejected

public String getStepnameRejected()

setLogInterval

public void setLogInterval(String logInterval)

Sets the logging interval in seconds. Disabled if the logging interval is <=0.

Parameters:

logInterval - The log interval value. A value higher than 0 means that the log table is updated every 'logInterval' seconds.

getLogInterval

public String getLogInterval()

Get the logging interval in seconds. Disabled if the logging interval is <=0. A value higher than 0 means that the log table is updated every 'logInterval' seconds.

Parameters:

logInterval - The log interval,

getLogSizeLimit

public String getLogSizeLimit()

Returns:

the logSizeLimit

setLogSizeLimit

public void setLogSizeLimit(String logSizeLimit)

Parameters:

logSizeLimit - the logSizeLimit to set

getLogRecord

public RowMetaAndData getLogRecord(LogStatus status,
                                   Object subject,
                                   Object parent)

This method calculates all the values that are required

Specified by:

getLogRecord in interface LogTableCoreInterface

Parameters:

id - the id to use or -1 if no id is needed

status - the log status to use

getLogTableCode

public String getLogTableCode()

Specified by:

getLogTableCode in class BaseLogTable

getLogTableType

public String getLogTableType()

Specified by:

getLogTableType in interface LogTableCoreInterface

getConnectionNameVariable

public String getConnectionNameVariable()

Specified by:

getConnectionNameVariable in interface LogTableCoreInterface

Specified by:

getConnectionNameVariable in class BaseLogTable

getSchemaNameVariable

public String getSchemaNameVariable()

Specified by:

getSchemaNameVariable in interface LogTableCoreInterface

Specified by:

getSchemaNameVariable in class BaseLogTable

getTableNameVariable

public String getTableNameVariable()

Specified by:

getTableNameVariable in interface LogTableCoreInterface

Specified by:

getTableNameVariable in class BaseLogTable

getRecommendedIndexes

public List<RowMetaInterface> getRecommendedIndexes()

Specified by:

getRecommendedIndexes in interface LogTableCoreInterface

setAllGlobalParametersToNull

public void setAllGlobalParametersToNull()

Overrides:

setAllGlobalParametersToNull in class BaseLogTable