org.pentaho.di.core.logging
Interface LogTableInterface

All Known Implementing Classes:

ChannelLogTable, JobEntryLogTable, JobLogTable, PerformanceLogTable, StepLogTable, TransLogTable

public interface LogTableInterface

Method Summary

String	getActualSchemaName()
String	getActualTableName()
String	getConnectionName()
String	getConnectionNameVariable()
DatabaseMeta	getDatabaseMeta()
LogTableField	getErrorsField()
List<LogTableField>	getFields()
LogTableField	getKeyField()
LogTableField	getLogDateField()
LogTableField	getLogField()
RowMetaAndData	getLogRecord(LogStatus status, Object subject, Object parent) Assemble the log record from the logging subject.
String	getLogTableType()
LogTableField	getNameField()
String	getQuotedSchemaTableCombination()
List<RowMetaInterface>	getRecommendedIndexes()
String	getSchemaName()
String	getSchemaNameVariable()
LogTableField	getStatusField()
String	getTableName()
String	getTableNameVariable()
String	getTimeoutInDays()
boolean	isDefined()
void	loadFromRepository(RepositoryAttributeInterface attributeInterface) Loads details of the log table from a repository.
void	saveToRepository(RepositoryAttributeInterface attributeInterface) Saves the log table to a repository.
void	setConnectionName(String connectionName)

Method Detail

saveToRepository

void saveToRepository(RepositoryAttributeInterface attributeInterface)
                      throws KettleException

Saves the log table to a repository.

Parameters:

attributeInterface - The attribute interface used to store the attributes

Throws:

KettleException

loadFromRepository

void loadFromRepository(RepositoryAttributeInterface attributeInterface)
                        throws KettleException

Loads details of the log table from a repository.

Parameters:

attributeInterface - The attribute interface used to load the attributes

Throws:

KettleException

getConnectionName

String getConnectionName()

setConnectionName

void setConnectionName(String connectionName)

getDatabaseMeta

DatabaseMeta getDatabaseMeta()

getFields

List<LogTableField> getFields()

getSchemaName

String getSchemaName()

Returns:

The locally defined log schema name

getTableName

String getTableName()

Returns:

The locally defined log table name

getActualSchemaName

String getActualSchemaName()

Returns:

The actual schema name taking into account optionally defined KETTLE variables for global logging configuration

getActualTableName

String getActualTableName()

Returns:

The actual table name taking into account optionally defined KETTLE variabled for global logging configuration

getLogRecord

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

Assemble the log record from the logging subject.

Parameters:

status - The status to log

subject - The subject object to log

parent - The parent object to log

Returns:

The log record to write

getLogTableType

String getLogTableType()

getConnectionNameVariable

String getConnectionNameVariable()

getSchemaNameVariable

String getSchemaNameVariable()

getTableNameVariable

String getTableNameVariable()

isDefined

boolean isDefined()

getTimeoutInDays

String getTimeoutInDays()

Returns:

The string that describes the timeout in days (variable supported) as a floating point number

getLogDateField

LogTableField getLogDateField()

Returns:

the field that represents the log date field or null if none was defined.

getKeyField

LogTableField getKeyField()

Returns:

the field that represents the key to this logging table (batch id etc)

getQuotedSchemaTableCombination

String getQuotedSchemaTableCombination()

Returns:

the appropriately quoted (by the database metadata) schema/table combination

getLogField

LogTableField getLogField()

Returns:

the field that represents the logging text (or null if none is found)

getStatusField

LogTableField getStatusField()

Returns:

the field that represents the status (or null if none is found)

getErrorsField

LogTableField getErrorsField()

Returns:

the field that represents the number of errors (or null if none is found)

getNameField

LogTableField getNameField()

Returns:

the field that represents the name of the object that is being used (or null if none is found)

getRecommendedIndexes

List<RowMetaInterface> getRecommendedIndexes()

Returns:

A list of rows that contain the recommended indexed fields for this logging table.