org.pentaho.di.datafactory

Interface DynamicDatasource

public interface DynamicDatasource

Interface for retrieving resources needed to establish a new datasource in the report engine. This allows plugins to provide the necessary resources to render any Kettle input step as a native datasource in Report Designer.

Author:

gmoran

Method Summary

Methods

Modifier and Type	Method and Description
String	getDialogClass() What class will represent the edit dialog for this datasource?
String	getQueryName() The name of the query as it appears in the UI of the receiver module.
String	getResourceEntryName() The name of the resource to embed the transformation as.
String	getStepName() The name of the step that represents the datasource, as it appears in the Kettle transformation template.
String	getTemplate() Return the name of the Kettle transformation template that holds the uninitialized input step.

Method Detail

getDialogClass

String getDialogClass()

What class will represent the edit dialog for this datasource?

Returns:

fully qualified class name of dialog class; must implement BaseStepGenericXulDialog

getTemplate

String getTemplate()

Return the name of the Kettle transformation template that holds the uninitialized input step. The template should reside in the archive next to the implementation of the DynamicDatasource interface.

Returns:

template name as String

getResourceEntryName

String getResourceEntryName()

The name of the resource to embed the transformation as.

Returns:

resource name as String

getStepName

String getStepName()

The name of the step that represents the datasource, as it appears in the Kettle transformation template.

Returns:

the step name as String

getQueryName

String getQueryName()

The name of the query as it appears in the UI of the receiver module. TODO: this should be localizable.

Returns:

the query name as String