DSIExtCustomBehaviorProvider Class Reference

A class that provides accessors for handlers and factories for custom engine behavior. In a sense, it acts as a provider of custom behavior for SimbaEngine. More...

List of all members.

Public Member Functions

 DSIExtCustomBehaviorProvider ()
 Constructor.
ICellComparatorFactoryGetCellComparatorFactory ()
 Gets a cell comparator factory for creating cell comparators for custom data types.
ICoercionHandlerGetCoercionHandler ()
 Gets a Coercion Handler for handing custom coercion rules.
IColumnFactoryGetColumnFactory ()
 Gets a column factory for creating columns for custom data types.
IFunctorFactoryGetFunctorFactory ()
 Gets a custom functor factory for handling the execution of operations for custom types.
virtual void InitializeCellComparatorFactory ()
 Initializes Cell Comparator Factory for a DSIExtCustomBehaviorProvider.
virtual void InitializeCoercionHandler ()
 Initializes Coercion Handler for a DSIExtCustomBehaviorProvider.
virtual void InitializeColumnFactory (DSIExtSqlDataEngine *in_dataEngine)
 Initializes Column Factory for a DSIExtCustomBehaviorProvider.
virtual void InitializeFunctorFactory ()
 Initializes Functor Factory for a DSIExtCustomBehaviorProvider.
virtual ~DSIExtCustomBehaviorProvider ()
 Destructor.

Protected Attributes

AutoPtr< ICellComparatorFactorym_cellComparatorFactory
AutoPtr< ICoercionHandlerm_coercionHandler
AutoPtr< IColumnFactorym_columnFactory
AutoPtr< IFunctorFactorym_functorFactory

Detailed Description

A class that provides accessors for handlers and factories for custom engine behavior. In a sense, it acts as a provider of custom behavior for SimbaEngine.

Custom behavior here means supporting custom coercion rules, the execution of operations for custom data types, comparisons between custom data types and custom text collation.

The intent of this class is to provide a central place for access to components involved with the handling of custom data types, or custom functionality. The DSII should override the various Initialize*() functions in their subclass if required. By default, the DSIExt handlers and factories will be used if the DSII does not override a particular handler or factory.


Constructor & Destructor Documentation

Constructor.

The Initialize*() functions will be called after construction to initialize the members of the provider.

virtual ~DSIExtCustomBehaviorProvider (  )  [virtual]

Destructor.


Member Function Documentation

ICellComparatorFactory* GetCellComparatorFactory (  ) 

Gets a cell comparator factory for creating cell comparators for custom data types.

Returns m_cellComparatorFactory's pointer. DO NOT override this function.

Returns:
An ICellComparatorFactory for creating cell comparators for custom data types; NULL if the feature is not supported. (NOT OWN)
ICoercionHandler* GetCoercionHandler (  ) 

Gets a Coercion Handler for handing custom coercion rules.

Returns m_coercionHandler's pointer. DO NOT override this function.

Returns:
An ICoercionHandler to handle custom coercion rules. (NOT OWN)
IColumnFactory* GetColumnFactory (  ) 

Gets a column factory for creating columns for custom data types.

Returns m_columnsFactory's pointer. DO NOT override this function.

Returns:
An IColumnFactory for creating columns for custom data types. (NOT OWN)
IFunctorFactory* GetFunctorFactory (  ) 

Gets a custom functor factory for handling the execution of operations for custom types.

Returns m_functorFactory's pointer. DO NOT override this function.

Returns:
An IFunctorFactory for creating functors for custom data types; NULL if the feature is not supported. (NOT OWN)
virtual void InitializeCellComparatorFactory (  )  [virtual]

Initializes Cell Comparator Factory for a DSIExtCustomBehaviorProvider.

Initializes m_cellComparatorFactory to its appropriate object.

The DSII should override this function to assign the member variable to the DSII subclass of ICellComparatorFactory.

This default implementation initializes the following: m_cellComparatorFactory = new DSIExtCellComparatorFactory

InitializeCellComparatorFactory() will be called after construction of a DSIExtCustomBehaviorProvider object.

virtual void InitializeCoercionHandler (  )  [virtual]

Initializes Coercion Handler for a DSIExtCustomBehaviorProvider.

Initializes m_coercionHandler to its appropriate object.

The DSII should override this function to assign the member variable to the DSII subclass of ICoercionhandler.

This default implementation initializes the following: m_coercionHandler = new DSIExtCoercionHandler

InitializeCoercionHandler() will be called after construction of a DSIExtCustomBehaviorProvider object.

virtual void InitializeColumnFactory ( DSIExtSqlDataEngine in_dataEngine  )  [virtual]

Initializes Column Factory for a DSIExtCustomBehaviorProvider.

Initializes m_columnFactory to its appropriate object.

The DSII should override this function to assign the member variable to the DSII subclass of IColumnFactory.

This default implementation initializes the following: m_columnFactory = new DSIExtColumnFactory.

InitializeColumnFactory() will be called after construction of a DSIExtCustomBehaviorProvider object.

virtual void InitializeFunctorFactory (  )  [virtual]

Initializes Functor Factory for a DSIExtCustomBehaviorProvider.

Initializes m_functorFactory to its appropriate object.

The DSII should override this function to assign the member variable to the DSII subclass of IFunctorFactory.

This default implementation initializes the following: m_functorFactory = new DSIExtFunctorFactory.

InitializeFunctorFactory() will be called after construction of a DSIExtCustomBehaviorProvider object.


Member Data Documentation


The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:17 2017 for SimbaEngine 10.1.3.1011 by simba