com.businessobjects.customds
Class AbstractCustomDataSource

java.lang.Object
  com.businessobjects.customds.AbstractCustomDataSource

All Implemented Interfaces:

CustomDataSource

public abstract class AbstractCustomDataSource
extends java.lang.Object
implements CustomDataSource

AbstractCustomDataSource is an abstract implementation class for CustomDataSource.

This class provides default implementation for a few methods in CustomDataSource. Methods that require plug-in specific implementation must be implemented by plug-in developers.

Since:

12.2

Constructor Summary

AbstractCustomDataSource()

Method Summary

void	clean() Default empty implementation.
int	getChunkSize() Returns the default chunk size.
java.util.Map	getDSParameters(java.util.Map currentDSParams) Returns null.
void	init(CustomDataSourceInfo customDataSourceInfo) Stores the complete CustomDataSourceInfo information.
boolean	isDataSourceParamsComplete(java.util.Map currentDSParams) Returns true.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.businessobjects.customds.CustomDataSource

getColumnsInfo, getCustomDataProvider, getExtensionBaseDescriptor

Constructor Detail

AbstractCustomDataSource

public AbstractCustomDataSource()

Method Detail

clean

public void clean()

Default empty implementation.

Specified by:

clean in interface CustomDataSource

See Also:

CustomDataSource.clean()

getChunkSize

public int getChunkSize()
                 throws DataSourceException

Returns the default chunk size. The value of the default chunk size is 100.

Specified by:

getChunkSize in interface CustomDataSource

Returns:

The default chunk size.

Throws:

DataSourceException - If the plug-in encounters any Exception while trying to get the size of chunk.

See Also:

CustomDataSource.getChunkSize(), DataSourceException

getDSParameters

public java.util.Map getDSParameters(java.util.Map currentDSParams)
                              throws DataSourceException

Returns null.

If this method is not overridden by the plug-in, then it indicates that the processing layer plug-in does not have any information to be sent to UserInterface plug-in.

Specified by:

getDSParameters in interface CustomDataSource

Parameters:

currentDSParams - The Map that contains the data source parameters.

Returns:

The Map object.

Throws:

DataSourceException - if the plug-in encounters any Exception while trying to build the additional set of information required to access the data source. Plug-in must mask handled exceptions as DataSourceException by using one of its types.

See Also:

CustomDataSource.getDSParameters(java.util.Map), DataSourceException

init

public void init(CustomDataSourceInfo customDataSourceInfo)
          throws DataSourceException

Stores the complete CustomDataSourceInfo information. Sub-classes can access this information through the member variable customDataSourceInfo.

Specified by:

init in interface CustomDataSource

Parameters:

customDataSourceInfo - The custom data source information.

Throws:

DataSourceException - if the plug-in encounters any Exception while processing the initial set of information. Plug-in must mask handled exceptions as DataSourceException by using one of its constructors. Most common DataSourceException can be either missing or invalid source (ErrorCodes.MINOR_FILE_MISSING or ErrorCodes.MINOR_INVALID_FILE_PATH).

See Also:

CustomDataSource.init(com.businessobjects.customds.common.CustomDataSourceInfo), CustomDataSourceInfo, DataSourceException

isDataSourceParamsComplete

public boolean isDataSourceParamsComplete(java.util.Map currentDSParams)
                                   throws DataSourceException

Returns true.

If this method is not overridden by the plug-in, then it indicates that the processing layer plug-in does not require User Interface.

Specified by:

isDataSourceParamsComplete in interface CustomDataSource

Parameters:

currentDSParams - The custom data source information.

Returns:

true

Throws:

DataSourceException - if the plug-in encounters any Exception while trying to verify if the user input is complete. The plug-in must mask handled exceptions as DataSourceException by using one of its constructors.

See Also:

CustomDataSource.isDataSourceParamsComplete(java.util.Map), DataSourceException