BaseLogTable (PDI Engine 8.2.0.1-349 API)

java.lang.Object
- org.pentaho.di.core.logging.BaseLogTable

Direct Known Subclasses:

ChannelLogTable, JobEntryLogTable, JobLogTable, MetricsLogTable, PerformanceLogTable, StepLogTable, TransLogTable
```
public abstract class BaseLogTable
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`connectionName`
`protected HasDatabasesInterface`	`databasesInterface`
`protected List<LogTableField>`	`fields`
`static String`	`PROP_LOG_TABLE_CONNECTION_NAME`
`static String`	`PROP_LOG_TABLE_FIELD_ENABLED`
`static String`	`PROP_LOG_TABLE_FIELD_ID`
`static String`	`PROP_LOG_TABLE_FIELD_NAME`
`static String`	`PROP_LOG_TABLE_FIELD_SUBJECT`
`static String`	`PROP_LOG_TABLE_INTERVAL`
`static String`	`PROP_LOG_TABLE_SCHEMA_NAME`
`static String`	`PROP_LOG_TABLE_SIZE_LIMIT`
`static String`	`PROP_LOG_TABLE_TABLE_NAME`
`static String`	`PROP_LOG_TABLE_TIMEOUT_DAYS`
`protected String`	`schemaName`
`protected VariableSpace`	`space`
`protected String`	`tableName`
`protected String`	`timeoutInDays`
`static String`	`XML_TAG`

Constructor Summary

Constructors
Constructor and Description
`BaseLogTable(VariableSpace space, HasDatabasesInterface databasesInterface, String connectionName, String schemaName, String tableName)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected Object`	`clone()`
`boolean`	`containsKeyField()`
`boolean`	`equals(Object obj)`
`LogTableField`	`findField(String id)` Find a log table field in this log table definition.
`String`	`getActualConnectionName()`
`String`	`getActualSchemaName()`
`String`	`getActualTableName()`
`String`	`getConnectionName()`
`abstract String`	`getConnectionNameVariable()`
`DatabaseMeta`	`getDatabaseMeta()`
`LogTableField`	`getErrorsField()`
`List<LogTableField>`	`getFields()`
`protected String`	`getFieldsXML()`
`LogTableField`	`getKeyField()`
`protected String`	`getLogBuffer(VariableSpace space, String logChannelId, LogStatus status, String limit)`
`LogTableField`	`getLogDateField()`
`LogTableField`	`getLogField()`
`abstract String`	`getLogTableCode()`
`LogTableField`	`getNameField()`
`String`	`getQuotedSchemaTableCombination()`
`String`	`getSchemaName()`
`abstract String`	`getSchemaNameVariable()`
`LogTableField`	`getStatusField()`
`Object`	`getSubject(String id)` Get the subject of a field with the specified ID
`String`	`getSubjectString(String id)` Return the subject in the form of a string for the specified ID.
`String`	`getTableName()`
`abstract String`	`getTableNameVariable()`
`String`	`getTimeoutInDays()`
`boolean`	`isDefined()`
`protected boolean`	`isGlobalParameter(String parameter)`
`void`	`loadFieldsXML(Node node)`
`void`	`loadFromRepository(RepositoryAttributeInterface attributeInterface)`
`void`	`replaceMeta(BaseLogTable baseLogTable)`
`void`	`saveToRepository(RepositoryAttributeInterface attributeInterface)` Save this core information of the log table to the repository using the specified attribute interface.
`void`	`setAllGlobalParametersToNull()`
`void`	`setConnectionName(String connectionName)`
`void`	`setFields(List<LogTableField> fields)`
`void`	`setSchemaName(String schemaName)`
`void`	`setTableName(String tableName)`
`void`	`setTimeoutInDays(String timeoutInDays)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

XML_TAG
```
public static final String XML_TAG
```
See Also:

Constant Field Values

PROP_LOG_TABLE_CONNECTION_NAME

public static String PROP_LOG_TABLE_CONNECTION_NAME

PROP_LOG_TABLE_SCHEMA_NAME

public static String PROP_LOG_TABLE_SCHEMA_NAME

PROP_LOG_TABLE_TABLE_NAME

public static String PROP_LOG_TABLE_TABLE_NAME

PROP_LOG_TABLE_FIELD_ID

public static String PROP_LOG_TABLE_FIELD_ID

PROP_LOG_TABLE_FIELD_NAME

public static String PROP_LOG_TABLE_FIELD_NAME

PROP_LOG_TABLE_FIELD_ENABLED

public static String PROP_LOG_TABLE_FIELD_ENABLED

PROP_LOG_TABLE_FIELD_SUBJECT

public static String PROP_LOG_TABLE_FIELD_SUBJECT

PROP_LOG_TABLE_INTERVAL

public static String PROP_LOG_TABLE_INTERVAL

PROP_LOG_TABLE_SIZE_LIMIT

public static String PROP_LOG_TABLE_SIZE_LIMIT

PROP_LOG_TABLE_TIMEOUT_DAYS

public static String PROP_LOG_TABLE_TIMEOUT_DAYS

space
```
protected VariableSpace space
```

databasesInterface

protected HasDatabasesInterface databasesInterface

connectionName
```
protected String connectionName
```

schemaName
```
protected String schemaName
```

tableName
```
protected String tableName
```

timeoutInDays
```
protected String timeoutInDays
```

fields
```
protected List<LogTableField> fields
```

Constructor Detail

BaseLogTable

public BaseLogTable(VariableSpace space,
                    HasDatabasesInterface databasesInterface,
                    String connectionName,
                    String schemaName,
                    String tableName)

Method Detail
- replaceMeta
```
public void replaceMeta(BaseLogTable baseLogTable)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- clone
```
protected Object clone()
                throws CloneNotSupportedException
```
  Overrides:
  
  clone in class Object
  
  Throws:
  
  CloneNotSupportedException
- saveToRepository
```
public void saveToRepository(RepositoryAttributeInterface attributeInterface)
                      throws KettleException
```
  Save this core information of the log table to the repository using the specified attribute interface.
  
  Parameters:
  
  attributeInterface - The attribute interface to use to set attributes
  
  Throws:
  
  KettleException
- loadFromRepository
```
public void loadFromRepository(RepositoryAttributeInterface attributeInterface)
                        throws KettleException
```
  Throws:
  
  KettleException
- getLogTableCode
```
public abstract String getLogTableCode()
```
- getConnectionNameVariable
```
public abstract String getConnectionNameVariable()
```
- getSchemaNameVariable
```
public abstract String getSchemaNameVariable()
```
- getTableNameVariable
```
public abstract String getTableNameVariable()
```
- getDatabaseMeta
```
public DatabaseMeta getDatabaseMeta()
```
  Returns:
  
  the databaseMeta
- getActualConnectionName
```
public String getActualConnectionName()
```
  Returns:
  
  the connectionName
- getActualSchemaName
```
public String getActualSchemaName()
```
  Returns:
  
  the schemaName
- setSchemaName
```
public void setSchemaName(String schemaName)
```
  Parameters:
  
  schemaName - the schemaName to set
- getSchemaName
```
public String getSchemaName()
```
- getActualTableName
```
public String getActualTableName()
```
  Returns:
  
  the tableName
- getTableName
```
public String getTableName()
```
- setTableName
```
public void setTableName(String tableName)
```
  Parameters:
  
  tableName - the tableName to set
- getQuotedSchemaTableCombination
```
public String getQuotedSchemaTableCombination()
```
- getFields
```
public List<LogTableField> getFields()
```
  Returns:
  
  the fields
- setFields
```
public void setFields(List<LogTableField> fields)
```
  Parameters:
  
  fields - the fields to set
- findField
```
public LogTableField findField(String id)
```
  Find a log table field in this log table definition. Use the id of the field to do the lookup.
  
  Parameters:
  
  id - the id of the field to search for
  
  Returns:
  
  the log table field or null if nothing was found.
- getSubject
```
public Object getSubject(String id)
```
  Get the subject of a field with the specified ID
  
  Parameters:
  
  id -
  
  Returns:
  
  the subject or null if no field could be find with the specified id
- getSubjectString
```
public String getSubjectString(String id)
```
  Return the subject in the form of a string for the specified ID.
  
  Parameters:
  
  id - the id of the field to look for.
  
  Returns:
  
  the string of the subject (name of step) or null if nothing was found.
- containsKeyField
```
public boolean containsKeyField()
```
- getLogDateField
```
public LogTableField getLogDateField()
```
  Returns:
  
  the field that represents the log date field or null if none was defined.
- getKeyField
```
public LogTableField getKeyField()
```
  Returns:
  
  the field that represents the key to this logging table (batch id etc)
- getLogField
```
public LogTableField getLogField()
```
  Returns:
  
  the field that represents the logging text (or null if none is found)
- getStatusField
```
public LogTableField getStatusField()
```
  Returns:
  
  the field that represents the status (or null if none is found)
- getErrorsField
```
public LogTableField getErrorsField()
```
  Returns:
  
  the field that represents the number of errors (or null if none is found)
- getNameField
```
public LogTableField getNameField()
```
  Returns:
  
  the field that represents the name of the object that is being used (or null if none is found)
- getFieldsXML
```
protected String getFieldsXML()
```
- loadFieldsXML
```
public void loadFieldsXML(Node node)
```
- isDefined
```
public boolean isDefined()
```
- getTimeoutInDays
```
public String getTimeoutInDays()
```
  Returns:
  
  the timeoutInDays
- setTimeoutInDays
```
public void setTimeoutInDays(String timeoutInDays)
```
  Parameters:
  
  timeoutInDays - the timeoutInDays to set
- getConnectionName
```
public String getConnectionName()
```
  Returns:
  
  the connectionName
- setConnectionName
```
public void setConnectionName(String connectionName)
```
  Parameters:
  
  connectionName - the connectionName to set
- getLogBuffer
```
protected String getLogBuffer(VariableSpace space,
                              String logChannelId,
                              LogStatus status,
                              String limit)
```
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object
- setAllGlobalParametersToNull
```
public void setAllGlobalParametersToNull()
```
- isGlobalParameter
```
protected boolean isGlobalParameter(String parameter)
```

Class BaseLogTable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XML_TAG

PROP_LOG_TABLE_CONNECTION_NAME

PROP_LOG_TABLE_SCHEMA_NAME

PROP_LOG_TABLE_TABLE_NAME

PROP_LOG_TABLE_FIELD_ID

PROP_LOG_TABLE_FIELD_NAME

PROP_LOG_TABLE_FIELD_ENABLED

PROP_LOG_TABLE_FIELD_SUBJECT

PROP_LOG_TABLE_INTERVAL

PROP_LOG_TABLE_SIZE_LIMIT

PROP_LOG_TABLE_TIMEOUT_DAYS

space

databasesInterface

connectionName

schemaName

tableName

timeoutInDays

fields

Constructor Detail

BaseLogTable

Method Detail

replaceMeta

toString

clone

saveToRepository

loadFromRepository

getLogTableCode

getConnectionNameVariable

getSchemaNameVariable

getTableNameVariable

getDatabaseMeta

getActualConnectionName

getActualSchemaName

setSchemaName

getSchemaName

getActualTableName

getTableName

setTableName

getQuotedSchemaTableCombination

getFields

setFields

findField

getSubject

getSubjectString

containsKeyField

getLogDateField

getKeyField

getLogField

getStatusField

getErrorsField

getNameField

getFieldsXML

loadFieldsXML

isDefined

getTimeoutInDays

setTimeoutInDays

getConnectionName

setConnectionName

getLogBuffer

equals

setAllGlobalParametersToNull

isGlobalParameter