Package org.pentaho.di.core
Interface ProvidesDatabaseConnectionInformation
-
- All Known Subinterfaces:
ProvidesModelerMeta
- All Known Implementing Classes:
DatabaseLookupMeta
,DimensionLookupMeta
,InsertUpdateMeta
,TableOutputMeta
public interface ProvidesDatabaseConnectionInformation
An interface for transformation steps that connect to a database table. For example a table output step or a bulk loader. This interface is used by the Agile BI plugin to determine which steps it can model or visualize.- Author:
- jamesdixon
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.pentaho.di.core.database.DatabaseMeta
getDatabaseMeta()
Returns the database meta for this stepString
getMissingDatabaseConnectionInformationMessage()
Provides a way for this object to return a custom message when database connection information is incomplete or missing.String
getSchemaName()
Returns the schema name for this step.String
getTableName()
Returns the table name for this step
-
-
-
Method Detail
-
getDatabaseMeta
org.pentaho.di.core.database.DatabaseMeta getDatabaseMeta()
Returns the database meta for this step- Returns:
-
getTableName
String getTableName()
Returns the table name for this step- Returns:
-
getSchemaName
String getSchemaName()
Returns the schema name for this step.- Returns:
-
getMissingDatabaseConnectionInformationMessage
String getMissingDatabaseConnectionInformationMessage()
Provides a way for this object to return a custom message when database connection information is incomplete or missing. If this returnsnull
a default message will be displayed for missing information.- Returns:
- A friendly message that describes that database connection information is missing and, potentially, why.
-
-