org.pentaho.reporting.engine.classic.core.metadata
Interface DataFactoryMetaData

All Superinterfaces:

MetaData

All Known Implementing Classes:

DefaultDataFactoryMetaData

public interface DataFactoryMetaData
extends MetaData

Todo: Document Me

Author:

Thomas Morgner

Method Summary

DataSourcePlugin	createEditor()
String	getDisplayConnectionName(DataFactory dataFactory)
Image	getIcon(Locale locale, int iconKind) Returns the icon for the datasource to be used in the UI.
Object	getQueryHash(DataFactory element, String queryName, DataRow parameter)
String[]	getReferencedFields(DataFactory element, String queryName, DataRow parameter) Returns the used parameter in the query.
ResourceReference[]	getReferencedResources(DataFactory element, org.pentaho.reporting.libraries.resourceloader.ResourceManager resourceManager, String queryName, DataRow parameter)
boolean	isEditable()
boolean	isEditorAvailable()
boolean	isFormattingMetaDataSource()
boolean	isFreeFormQuery()

Methods inherited from interface org.pentaho.reporting.engine.classic.core.metadata.MetaData

getCompatibilityLevel, getDeprecationMessage, getDescription, getDisplayName, getGrouping, getGroupingOrdinal, getItemOrdinal, getMetaAttribute, getName, isDeprecated, isExperimental, isExpert, isHidden, isPreferred

Method Detail

getIcon

Image getIcon(Locale locale,
              int iconKind)

Returns the icon for the datasource to be used in the UI.

Parameters:

locale - the locale.

iconKind - one of java.beans.BeanInfo#ICON_COLOR_16x16, java.beans.BeanInfo#ICON_COLOR_32x32, java.beans.BeanInfo#ICON_MONO_16x16, or java.beans.BeanInfo#ICON_MONO_32x32

Returns:

the image or null, if there is no icon.

See Also:

for the general semantics

getReferencedFields

String[] getReferencedFields(DataFactory element,
                             String queryName,
                             DataRow parameter)

Returns the used parameter in the query. The data factory must be open.

Parameters:

element - the element.

queryName - the query name.

Returns:

the list of parameters or null, if there is no information on referenced fields.

getReferencedResources

ResourceReference[] getReferencedResources(DataFactory element,
                                           org.pentaho.reporting.libraries.resourceloader.ResourceManager resourceManager,
                                           String queryName,
                                           DataRow parameter)

isEditable

boolean isEditable()

isEditorAvailable

boolean isEditorAvailable()

isFreeFormQuery

boolean isFreeFormQuery()

isFormattingMetaDataSource

boolean isFormattingMetaDataSource()

createEditor

DataSourcePlugin createEditor()

getDisplayConnectionName

String getDisplayConnectionName(DataFactory dataFactory)

getQueryHash

Object getQueryHash(DataFactory element,
                    String queryName,
                    DataRow parameter)