com.businessobjects.rebean.wi
Interface ChangeDataSourceMapping

public interface ChangeDataSourceMapping

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

ChangeDataSourceMapping interface defines a mapping from a set of objects from a data source that is being replaced, to a set of objects from the new data source.

Since:

11.5

Method Summary

ChangeDataSourceObjectMapping[]	getAllMappings() Returns all object mappings, from any data provider.
int	getDataProviderCount() The number of data providers that are impacted by this change of data source.
java.lang.String	getDataProviderName(int dataProviderIndex) The name of a data provider at a given index.
ChangeDataSourceObjectMapping[]	getMappingsForDataProvider(int dataProviderIndex) Returns all object mappings for a certain data provider.
DataSource	getNewDataSource() The new data source, replacing the old one.
DataSource	getOldDataSource() The data source that is being replaced.

Method Detail

getOldDataSource

DataSource getOldDataSource()

The data source that is being replaced.

Returns:

The data source that is being replaced.

getNewDataSource

DataSource getNewDataSource()

The new data source, replacing the old one.

Returns:

The new data source.

getAllMappings

ChangeDataSourceObjectMapping[] getAllMappings()

Returns all object mappings, from any data provider.

As this method returns an array, clients can theoretically change the values in the array. Changing the order has no effect, removing entries (setting them to null) will result in the source object not being replaced and therefore removed from the document.

Returns:

All object mappings.

getDataProviderCount

int getDataProviderCount()

The number of data providers that are impacted by this change of data source. In other words, this method returns the number of data providers that are based on the data source that is being replaced.

Returns:

The number of data providers.

getDataProviderName

java.lang.String getDataProviderName(int dataProviderIndex)

The name of a data provider at a given index.

Parameters:

dataProviderIndex - The data provider index.

Returns:

The data provider name.

Throws:

java.lang.IndexOutOfBoundsException - Thrown when dataProviderIndex < 0 or dataProviderIndex >= ChangeDataSourceMapping.getDataProviderCount().

getMappingsForDataProvider

ChangeDataSourceObjectMapping[] getMappingsForDataProvider(int dataProviderIndex)

Returns all object mappings for a certain data provider.

As this method returns an array, clients can theoretically change the values in the array. Changing the order has no effect, removing entries (setting them to null) will result in the source object not being replaced and therefore removed from the document.

Parameters:

dataProviderIndex - The data provider index.

Returns:

The data source object mappings for the given data provider.

Throws:

java.lang.IndexOutOfBoundsException - Thrown when dataProviderIndex < 0 or dataProviderIndex >= ChangeDataSourceMapping.getDataProviderCount().