51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

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

Detailed Description

Abstract base class that exposes the common options that all 51Degrees on-premise 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 :OnPremiseAspectEngineBuilderBase 
TBuilder :TBuilder 
TBuilder :TEngine 
TEngine :IOnPremiseAspectEngine 

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

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >:

[legend]

Public Member Functions

 OnPremiseAspectEngineBuilderBase (IDataUpdateService dataUpdateService)
Constructor More...
TBuilder  AddDataFile (IDataFileConfiguration configuration)
Add a data file for this engine to use. More...
TBuilder  SetTempDirPath (string dirPath)
Set the temporary path to use when the engine needs to create temporary files. More...
abstract TBuilder  SetPerformanceProfile (PerformanceProfiles profile)
Set the performance profile that the engine should use. More...

Public Member Functions inherited from FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >

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 AspectEngineDataFile  NewAspectEngineDataFile ()
Create a new instance of the AspectEngineDataFile instances used by the engine associated with this builder. More...
override void  PreCreateEngine ()
Called by the 'BuildEngine' method to handle anything that needs doing before the engine is built. More...
override void  ConfigureEngine (TEngine engine)
Called by the 'BuildEngine' method to handle configuration of the engine after it is built. More...

Protected Member Functions inherited from FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >

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< IDataFileConfiguration >  DataFileConfigs = new List<IDataFileConfiguration>() [get, set]
A list of the IDataFileConfiguration instances for all data files being supplied to the engine. More...
List< AspectEngineDataFile >  DataFiles = new List<AspectEngineDataFile>() [get, set]
Used to store a temporary list of the data file meta data between their creation and the creation of the engine. More...
string  TempDir = Path.GetTempPath() [get, set]
The directory to use for temporary files when needed More...

Properties inherited from FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >

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

Constructor & Destructor Documentation

Member Function Documentation

◆ ConfigureEngine()

override void FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< 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 from FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >.

◆ NewAspectEngineDataFile()

protected virtual

Create a new instance of the AspectEngineDataFile instances used by the engine associated with this builder.

If the engine uses a derived type then this method should be overridden to return a new instance on that type.

Returns
A new AspectEngineDataFile instance.

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

◆ SetTempDirPath()

TBuilder FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.SetTempDirPath ( string   dirPath )

Set the temporary path to use when the engine needs to create temporary files.

(e.g. when downloading data updates) Default = Path.GetTempPath();

Parameters
dirPath - The full path to the temporary directory
Returns
This engine builder instance.

Property Documentation