\r\n

51Degrees Pipeline Java  4.4

51Degrees Pipeline for Java

Search

Documentation

• fiftyone
• pipeline
• engines
• flowelements
• AspectEngineBuilderBase

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 >:

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

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	setProperties (List< String > properties) Configure the properties that the engine will populate in the response. More...
TBuilder	setProperties (String properties) Configure the 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) throws Exception 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

CacheConfiguration  cacheConfig = null

Constructor & Destructor Documentation

◆ AspectEngineBuilderBase()

fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.AspectEngineBuilderBase

(

ILoggerFactory

loggerFactory

)

Construct a new instance using the ILoggerFactory supplied.

Parameters

loggerFactory - the logger factory to use

Member Function Documentation

◆ buildEngine()

TEngine fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.buildEngine

(

)

throws Exception

protected

Build an engine using the configured options.

Derived classes should call this method when building an engine to ensure it is configured correctly all down the class hierarchy.

Returns

an AspectEngine

Exceptions

Exception - if the engine could not be created

◆ 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

◆ newEngine()

abstract TEngine fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.newEngine

(

List< String >

properties

)

throws Exception

abstract protected

Called by the buildEngine() method to handle creation of the engine instance.

Parameters

properties - the properties list to create the engine with

Returns

an AspectEngine

Exceptions

Exception - if the engine could not be created

◆ preCreateEngine()

void fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.preCreateEngine

(

)

protected

Called by the buildEngine() method to handle anything that needs doing before the engine is built.

By default, nothing needs to be done.

◆ setCache()

TBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.setCache

(

CacheConfiguration

cacheConfiguration

)

Configure the results cache that will be used by the Pipeline to cache results from this engine.

Parameters

cacheConfiguration - the cache configuration to use

Returns

this builder

◆ setLazyLoading()

TBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.setLazyLoading

(

LazyLoadingConfiguration

configuration

)

Configure lazy loading of results.

Parameters

configuration - the configuration to use

Returns

this builder

◆ setProperties() [1/3]

TBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.setProperties

(

Set< AspectPropertyMetaData >

set

)

Configure the properties that the engine will populate in the response.

By default all properties will be populated.

Parameters

set - The properties that we want the engine to populate

Returns

this builder

◆ setProperties() [2/3]

TBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.setProperties

(

List< String >

properties

)

Configure the properties that the engine will populate in the response.

By default all properties will be populated.

Parameters

properties - The properties that we want the engine to populate

Returns

this builder

◆ setProperties() [3/3]

TBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.setProperties

(

String

properties

)

Configure the properties that the engine will populate in the response.

By default, all properties will be populated.

Parameters

properties - The properties that we want the engine to populate

Returns

this builder

◆ setProperty() [1/2]

TBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.setProperty

(

String

s

)

Add a property to the list of properties that the engine will populate in the response.

By default, all properties will be populated.

Parameters

s - the property that we want the engine to populate

Returns

this builder

◆ setProperty() [2/2]

TBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.setProperty

(

AspectPropertyMetaData

aspectProperty

)

Add a property to the list of properties that the engine will populate in the response.

By default all properties will be populated.

Parameters

aspectProperty - the property that we want the engine to populate

Returns

this builder

On This Page

• Public Member Functions
• Protected Member Functions
• Protected Attributes
• List of all members

Generated by doxygen 1.8.15