51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine > Class Template Reference abstract

Detailed Description

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

Template 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
Type Constraints
TBuilder :AspectEngineBuilderBase 
TBuilder :TBuilder 
TBuilder :TEngine 
TEngine :IAspectEngine 

Inheritance diagram for FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >:

[legend]

Public Member Functions

TBuilder  SetLazyLoading (LazyLoadingConfiguration lazyLoadingConfig)
Configure lazy loading of results. More...
TBuilder  SetLazyLoadingTimeout (int timeoutMs)
Configure lazy loading of results. More...
TBuilder  SetCache (CacheConfiguration cacheConfig)
Configure the results cache that will be used by the Pipeline to cache results from this engine. More...
TBuilder  SetCacheSize (int cacheSize)
Configure the results cache that will be used by the Pipeline to cache results from this engine. More...
TBuilder  SetProperties (List< string > properties)
Configure the properties that the engine will populate in the response. More...
TBuilder  SetProperty (string property)
Add a property to the list of properties that the engine will populate in the response. More...

Protected Member Functions

virtual void  ConfigureEngine (TEngine engine)
Called by the BuildEngine() method to handle configuration of the engine after it is built. More...
virtual 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 ()
Build an engine using the configured options. More...

Properties

List< string >  Properties = new List<string>() [get]
A list of the string keys of properties that the user wants the engine to determine values for. More...

Member Function Documentation

◆ ConfigureEngine()

virtual void FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >.ConfigureEngine ( TEngine   engine )
protected virtual

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.

Reimplemented in FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.

◆ SetProperties()

TBuilder FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >.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 engine builder instance.

◆ SetProperty()

TBuilder FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >.SetProperty ( string   property )

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

By default all properties will be populated.

Parameters
property - The property that we want the engine to populate.
Returns
This engine builder instance.

Property Documentation