◆ 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 protectedBuild 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
◆ configureEngine()
void fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.configureEngine ( TEngine engine ) throws Exception protectedCalled 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 ( ) protectedGet 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 ) abstract protectedCalled by the buildEngine() method to handle creation of the engine instance.
- Parameters
-
- properties - the properties list to create the engine with
- Returns
- an AspectEngine
◆ preCreateEngine()
void fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.preCreateEngine ( ) protectedCalled 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()
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
◆ 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