Detailed Description
AspectEngines are a subset of FlowElements.
- See also
- Specification
- Parameters
-
<TData> the type of aspect data that the flow element will write to <TProperty> the type of meta data that the flow element will supply about the properties it populates.
Inheritance diagram for fiftyone.pipeline.engines.flowelements.AspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >:
Collaboration diagram for fiftyone.pipeline.engines.flowelements.AspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >:
Public Member Functions | |
| void | setCache (FlowCache cache) |
| Set the results cache. | |
| String | getDataSourceTier () |
| Get the tier to which the current data source belongs. | |
| void | setLazyLoading (LazyLoadingConfiguration configuration) |
| Configure lazy loading of results. | |
| LazyLoadingConfiguration | getLazyLoadingConfiguration () |
| Get the lazy loading configuration used for loading of results. | |
| ExecutorService | getExecutor () |
| Get the executor service to use when starting processing threads which are lazily loaded. | |
Public Member Functions inherited from fiftyone.pipeline.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData > | |
| void | process (FlowData data) throws Exception |
Carry out whatever operations this element is designed to do using the FlowData passed. | |
| void | addPipeline (Pipeline pipeline) |
| Called when this element is added to a pipeline. | |
| EvidenceKeyFilter | getEvidenceKeyFilter () |
| Get a filter that will only include the evidence keys that this element can make use of. | |
| String | getElementDataKey () |
Get the string name of the key used to access the data populated by this element in the FlowData. | |
| TypedKey< TData > | getTypedDataKey () |
| Get the typed data key used for retrieving strongly typed element data. | |
| List< TProperty > | getProperties () |
| Get details of the properties that this element can populate. | |
| TProperty | getProperty (String name) |
| Get a property from the properties that this element can populate using its name. | |
| boolean | isConcurrent () |
if true, requires that the Pipeline guards against concurrent access to FlowData structures | |
| boolean | isClosed () |
Indicates whether the element has been closed using the close() method, either explicitly or as a result of a 'try with resource'. | |
| DataFactory< TData > | getDataFactory () |
| Get the factory used to create the element data instances that are populated by this flow element. | |
Member Function Documentation
◆ getDataSourceTier()
| String fiftyone.pipeline.engines.flowelements.AspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >.getDataSourceTier | ( | ) |
Get the tier to which the current data source belongs.
For 51Degrees this will usually be one of: Lite Premium Enterprise
- Returns
- data tier
◆ getExecutor()
| ExecutorService fiftyone.pipeline.engines.flowelements.AspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >.getExecutor | ( | ) |
Get the executor service to use when starting processing threads which are lazily loaded.
- Returns
- an
ExecutorService
◆ getLazyLoadingConfiguration()
| LazyLoadingConfiguration fiftyone.pipeline.engines.flowelements.AspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >.getLazyLoadingConfiguration | ( | ) |
Get the lazy loading configuration used for loading of results.
- Returns
- lazy loading configuration
◆ setCache()
| void fiftyone.pipeline.engines.flowelements.AspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >.setCache | ( | FlowCache | cache | ) |
Set the results cache.
This is used to store the results of queries against the evidence that was provided. If the same evidence is provided again then the cached response is returned without needing to call the engine itself.
- Parameters
-
cache the cache to use
◆ setLazyLoading()
| void fiftyone.pipeline.engines.flowelements.AspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >.setLazyLoading | ( | LazyLoadingConfiguration | configuration | ) |
Configure lazy loading of results.
- Parameters
-
configuration the configuration to use