\r\n

51Degrees Pipeline .NET  4.3

51Degrees Pipeline for .NET

Examples.OnPremiseEngine.FlowElements.SimpleOnPremiseEngine Class Reference

Detailed Description

[class] [constructor]

Inheritance diagram for Examples.OnPremiseEngine.FlowElements.SimpleOnPremiseEngine:

[legend]

Collaboration diagram for Examples.OnPremiseEngine.FlowElements.SimpleOnPremiseEngine:

[legend]

Public Member Functions

 SimpleOnPremiseEngine (string dataFilePath, ILogger< AspectEngineBase< IStarSignData, IAspectPropertyMetaData >> logger, Func< IPipeline, FlowElementBase< IStarSignData, IAspectPropertyMetaData >, IStarSignData > aspectDataFactory, string tempDataFilePath)
override void  RefreshData (string dataFileIdentifier)
Causes the engine to reload data from the file at IAspectEngineDataFile.DataFilePath for the data file matching the given identifier. More...
override void  RefreshData (string dataFileIdentifier, Stream data)
Causes the engine to reload data from the supplied Stream for the file matching the given identifier. More...

Public Member Functions inherited from FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< IStarSignData, IAspectPropertyMetaData >

 OnPremiseAspectEngineBase (ILogger< AspectEngineBase< T, TMeta >> logger, Func< IPipeline, FlowElementBase< T, TMeta >, T > aspectDataFactory, string tempDataFilePath)
Constructor More...
IAspectEngineDataFile  GetDataFileMetaData (string dataFileIdentifier=null)
Get the details of a specific data file used by this engine. More...
virtual void  AddDataFile (IAspectEngineDataFile dataFile)
Add the specified data file to the engine. More...

Public Attributes

override string  ElementDataKey => "starsign"
[init]
override IEvidenceKeyFilter  EvidenceKeyFilter
override IList< IAspectPropertyMetaData >  Properties
override string  DataSourceTier => "free"

Public Attributes inherited from FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< IStarSignData, IAspectPropertyMetaData >

IReadOnlyList< IAspectEngineDataFile >  DataFiles
Details of the data files used by this engine. More...

Protected Member Functions

override void  ProcessEngine (IFlowData data, IStarSignData aspectData)
override void  UnmanagedResourcesCleanup ()

Protected Member Functions inherited from FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< IStarSignData, IAspectPropertyMetaData >

override void  ManagedResourcesCleanup ()
Called when this instance is being disposed More...

Member Function Documentation

◆ RefreshData() [1/2]

override void Examples.OnPremiseEngine.FlowElements.SimpleOnPremiseEngine.RefreshData ( string   dataFileIdentifier )
virtual

Causes the engine to reload data from the file at IAspectEngineDataFile.DataFilePath for the data file matching the given identifier.

Implementors should consider thread-safety to ensure that parallel calls to 'Process' will resolve as normal.

Parameters
dataFileIdentifier - The identifier of the data file to update. Must match the value in IAspectEngineDataFile.Identifier. If the engine only has a single data file, this parameter is ignored. If null is passed then all data files should be refreshed.

Implements FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< IStarSignData, IAspectPropertyMetaData >.

◆ RefreshData() [2/2]

override void Examples.OnPremiseEngine.FlowElements.SimpleOnPremiseEngine.RefreshData ( string   dataFileIdentifier,
Stream   data  
)
virtual

Causes the engine to reload data from the supplied Stream for the file matching the given identifier.

Implementors should consider thread-safety to ensure that parallel calls to 'Process' will resolve as normal.

Parameters
dataFileIdentifier - The identifier of the data file to update. Must match the value in IAspectEngineDataFile.Identifier. If the engine only has a single data file, this parameter is ignored.
data - A Stream containing the data to use when refreshing.

Implements FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< IStarSignData, IAspectPropertyMetaData >.

Member Data Documentation

◆ EvidenceKeyFilter

override IEvidenceKeyFilter Examples.OnPremiseEngine.FlowElements.SimpleOnPremiseEngine.EvidenceKeyFilter
Initial value:
=>
new EvidenceKeyFilterWhitelist(new List<string>() { "date-of-birth" })

◆ Properties

override IList<IAspectPropertyMetaData> Examples.OnPremiseEngine.FlowElements.SimpleOnPremiseEngine.Properties
Initial value:
=> new List<IAspectPropertyMetaData>() {
new AspectPropertyMetaData(this, "starsign", typeof(string), "starsign", new List<string>(){"free"}, true),
}