com.sap.dictionary.runtime
Interface IDataProvider

public interface IDataProvider

Method Summary

java.lang.ClassLoader	getClassLoader() Returns the provider's class loader
ISimpleType	getCurrencyUnitType(java.lang.String unitKey, java.util.Locale locale) Delivers the currency key decimal information The names are choosen according to the following definition Type Type Name Example Content amountType amount A decimal type 123,45 unitKeyType unitKey CURR_PACKAGE.currency EUR unitType unit CURR_PACKAGE.EUR e
IDataType	getDataType(java.lang.String name, java.util.Locale locale) Returns a dataType
IDataType	getDataType(java.lang.String name, java.util.Locale locale, java.lang.Object providerInfo) Returns a dataType
IDataType	getDataTypeFromCache(java.lang.String name, java.util.Locale locale) Returns a dataType if it is in provider cache
com.sap.typeservices.ITextServices	getTextService(ISimpleType simpleType) Returns a TextService
ISimpleType	getUnitOfMeasureType(java.lang.String unitKey, java.util.Locale locale) Delivers the unit of measure key decimal information Type Type Name Example Content amountType amount A decimal type 123,45 unitKeyType unitKey CURR_PACKAGE.currency EUR unitType unit CURR_PACKAGE.EUR e
com.sap.typeservices.ISimpleValueServices	getValueService(ISimpleType simpleType) Returns a ValueService
boolean	needsTranslator() Informs if the current translator needs a NameTranslator which changes the names of found objects from internal names of the backendsystem to frontend names

Method Detail

getDataType

public IDataType getDataType(java.lang.String name,
                             java.util.Locale locale)
                      throws com.sap.dictionary.runtime.DdException

Returns a dataType

Parameters:

name - - contains type-package and type-name locale - the locale for text-information in dataType

Returns:

dataType is delivered as IDataType

Throws:

com.sap.dictionary.runtime.DdException - if dataType could not be found

getDataType

public IDataType getDataType(java.lang.String name,
                             java.util.Locale locale,
                             java.lang.Object providerInfo)
                      throws com.sap.dictionary.runtime.DdException

Returns a dataType

Parameters:

name - - contains type-package and type-name locale - the locale for text-information in dataType providerInfo - information for all non-java providers to convert backend names

Returns:

dataType is delivered as IDataType

Throws:

com.sap.dictionary.runtime.DdException - if dataType could not be found

getDataTypeFromCache

public IDataType getDataTypeFromCache(java.lang.String name,
                                      java.util.Locale locale)

Returns a dataType if it is in provider cache

Parameters:

name - - contains type-package and type-name locale - the locale for text-information in dataType

Returns:

dataType is delivered as IDataType, null is returned if nothing is found in cache.

getValueService

public com.sap.typeservices.ISimpleValueServices getValueService(ISimpleType simpleType)
                                                          throws com.sap.dictionary.runtime.DdException

Returns a ValueService

Parameters:

simpleType - - the simple Type to take the text information from

Returns:

valueService is delivered as IValueService

getTextService

public com.sap.typeservices.ITextServices getTextService(ISimpleType simpleType)
                                                  throws com.sap.dictionary.runtime.DdException

Returns a TextService

Parameters:

simpleType - - the simple Type to take the text information from

Returns:

textService is delivered as IValueService

getCurrencyUnitType

public ISimpleType getCurrencyUnitType(java.lang.String unitKey,
                                       java.util.Locale locale)
                                throws com.sap.dictionary.runtime.DdException

Delivers the currency key decimal information The names are choosen according to the following definition Type Type Name Example Content amountType amount A decimal type 123,45 unitKeyType unitKey CURR_PACKAGE.currency EUR unitType unit CURR_PACKAGE.EUR e

Parameters:

unitKey - - the name of the unitKeyType

Returns:

a SimpleType containing the nesessary currency key information

getUnitOfMeasureType

public ISimpleType getUnitOfMeasureType(java.lang.String unitKey,
                                        java.util.Locale locale)
                                 throws com.sap.dictionary.runtime.DdException

Delivers the unit of measure key decimal information Type Type Name Example Content amountType amount A decimal type 123,45 unitKeyType unitKey CURR_PACKAGE.currency EUR unitType unit CURR_PACKAGE.EUR e

Parameters:

unitKey - - the name of the unitOfMeasureType

Returns:

a SimpleType containing the nesessary currency key information

getClassLoader

public java.lang.ClassLoader getClassLoader()

Returns the provider's class loader

Returns:

the providers class loader if available, null otherwise

needsTranslator

public boolean needsTranslator()

Informs if the current translator needs a NameTranslator which changes the names of found objects from internal names of the backendsystem to frontend names

Returns:

true, if a NameTranslator is necessary, false otherwise