51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine > Class Template Reference abstract

Detailed Description

Abstract base class that exposes the common options that all 51Degrees engine builders should make use of.

Parameters
<TBuilder> - the specific builder type to use as the return type from the fluent builder methods
<TEngine> - the type of the engine that this builder will build

Inheritance diagram for fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >:

[legend]

Collaboration diagram for fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >:

[legend]

Public Member Functions

 AspectEngineBuilderBase ()
Default constructor which uses the ILoggerFactory implementation returned by LoggerFactory#getILoggerFactory().
 AspectEngineBuilderBase (ILoggerFactory loggerFactory)
Construct a new instance using the ILoggerFactory supplied. More...
TBuilder  setProperties (Set< AspectPropertyMetaData > set)
Configure the properties that the engine will populate in the response. More...
TBuilder  setProperty (String s)
Add a property to the list of properties that the engine will populate in the response. More...
TBuilder  setProperty (AspectPropertyMetaData aspectProperty)
Add a property to the list of properties that the engine will populate in the response. More...
TBuilder  setLazyLoading (LazyLoadingConfiguration configuration)
Configure lazy loading of results. More...
TBuilder  setCache (CacheConfiguration cacheConfiguration)
Configure the results cache that will be used by the Pipeline to cache results from this engine. More...

Protected Member Functions

List< String >  getProperties ()
Get the list of properties that have been added to the builder. More...
void  configureEngine (TEngine engine) throws Exception
Called by the buildEngine() method to handle configuration of the engine after it is built. More...
void  preCreateEngine ()
Called by the buildEngine() method to handle anything that needs doing before the engine is built. More...
abstract TEngine  newEngine (List< String > properties)
Called by the buildEngine() method to handle creation of the engine instance. More...
TEngine  buildEngine () throws Exception
Build an engine using the configured options. More...

Protected Attributes

final ILoggerFactory  loggerFactory

Constructor & Destructor Documentation

Member Function Documentation

◆ configureEngine()

void fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.configureEngine ( TEngine   engine ) throws Exception
protected

Called by the buildEngine() method to handle configuration of the engine after it is built.

Can be overridden by derived classes to add additional configuration, but the base method should always be called.

Parameters
engine - the engine to configure
Exceptions
Exception - if an exception occurred which configuring the engine

◆ getProperties()

List<String> fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.getProperties ( )
protected

Get the list of properties that have been added to the builder.

Duplicate properties have been removed. This list represents the properties which the user wants to retrieve from the engine. If the list is empty, this means the user wants all properties available.

Returns
list of required properties