Package org.pentaho.reporting.engine.classic.core.metadata

Class DefaultDataFactoryMetaData

java.lang.Object

org.pentaho.reporting.engine.classic.core.metadata.AbstractMetaData

org.pentaho.reporting.engine.classic.core.metadata.DefaultDataFactoryMetaData

All Implemented Interfaces:

Serializable, DataFactoryMetaData, MetaData

public class DefaultDataFactoryMetaData
extends AbstractMetaData
implements DataFactoryMetaData

See Also:

Serialized Form

Field Summary

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

VALUEROLE_BUNDLE_KEY, VALUEROLE_BUNDLE_NAME, VALUEROLE_CONTENT, VALUEROLE_DATEFORMAT, VALUEROLE_ELEMENT_NAME, VALUEROLE_FIELD, VALUEROLE_FORMULA, VALUEROLE_GROUP, VALUEROLE_MESSAGE, VALUEROLE_NUMBERFORMAT, VALUEROLE_QUERY, VALUEROLE_RESOURCE, VALUEROLE_VALUE

Constructor Summary

Constructors

Constructor	Description
DefaultDataFactoryMetaData(String dataFactory, String bundleLocation, String keyPrefix, boolean expert, boolean preferred, boolean hidden, boolean deprecated, boolean editable, boolean freeformQuery, boolean formattingMetadataSource, boolean experimental, DataFactoryCore dataFactoryCore, int compatibilityLevel)	Deprecated.
DefaultDataFactoryMetaData(String dataFactory, String bundleLocation, String keyPrefix, boolean expert, boolean preferred, boolean hidden, boolean deprecated, boolean editable, boolean freeformQuery, boolean formattingMetadataSource, MaturityLevel maturityLevel, DataFactoryCore dataFactoryCore, int compatibilityLevel)
DefaultDataFactoryMetaData(DataFactoryMetaDataBuilder builder)

Method Summary

Modifier and Type	Method	Description
protected String	computePrefix(String keyPrefix, String name)
DataSourcePlugin	createEditor()
String	getDisplayConnectionName(DataFactory dataFactory)
protected String	getEditorConfigurationKey()
Object	getQueryHash(DataFactory dataFactory, 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()
String	toString()

Methods inherited from class org.pentaho.reporting.engine.classic.core.metadata.AbstractMetaData

getBundle, getBundleLocation, getCompatibilityLevel, getDeprecationMessage, getDescription, getDisplayName, getFeatureMaturityLevel, getGrouping, getGroupingOrdinal, getIcon, getItemOrdinal, getKeyPrefix, getMetaAttribute, getName, isDeprecated, isExperimental, isExpert, isHidden, isPreferred

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getIcon

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

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

Constructor Detail

DefaultDataFactoryMetaData

@Deprecated
public DefaultDataFactoryMetaData(String dataFactory,
                                  String bundleLocation,
                                  String keyPrefix,
                                  boolean expert,
                                  boolean preferred,
                                  boolean hidden,
                                  boolean deprecated,
                                  boolean editable,
                                  boolean freeformQuery,
                                  boolean formattingMetadataSource,
                                  boolean experimental,
                                  DataFactoryCore dataFactoryCore,
                                  int compatibilityLevel)

Deprecated.

DefaultDataFactoryMetaData

public DefaultDataFactoryMetaData(String dataFactory,
                                  String bundleLocation,
                                  String keyPrefix,
                                  boolean expert,
                                  boolean preferred,
                                  boolean hidden,
                                  boolean deprecated,
                                  boolean editable,
                                  boolean freeformQuery,
                                  boolean formattingMetadataSource,
                                  MaturityLevel maturityLevel,
                                  DataFactoryCore dataFactoryCore,
                                  int compatibilityLevel)

DefaultDataFactoryMetaData

public DefaultDataFactoryMetaData(DataFactoryMetaDataBuilder builder)

Method Detail

computePrefix

protected String computePrefix(String keyPrefix,
                               String name)

Overrides:

computePrefix in class AbstractMetaData

getReferencedFields

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

Description copied from interface: DataFactoryMetaData

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

Specified by:

getReferencedFields in interface DataFactoryMetaData

Parameters:

element - the element.

queryName - the query name.

Returns:

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

getReferencedResources

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

Specified by:

getReferencedResources in interface DataFactoryMetaData

isEditable

public boolean isEditable()

Specified by:

isEditable in interface DataFactoryMetaData

isEditorAvailable

public boolean isEditorAvailable()

Specified by:

isEditorAvailable in interface DataFactoryMetaData

createEditor

public DataSourcePlugin createEditor()

Specified by:

createEditor in interface DataFactoryMetaData

getEditorConfigurationKey

protected String getEditorConfigurationKey()

isFreeFormQuery

public boolean isFreeFormQuery()

Specified by:

isFreeFormQuery in interface DataFactoryMetaData

isFormattingMetaDataSource

public boolean isFormattingMetaDataSource()

Specified by:

isFormattingMetaDataSource in interface DataFactoryMetaData

toString

public String toString()

Overrides:

toString in class Object

getDisplayConnectionName

public String getDisplayConnectionName(DataFactory dataFactory)

Specified by:

getDisplayConnectionName in interface DataFactoryMetaData

getQueryHash

public Object getQueryHash(DataFactory dataFactory,
                           String queryName,
                           DataRow parameter)

Specified by:

getQueryHash in interface DataFactoryMetaData