Abstract base class that exposes the common options that all 51Degrees engine builders should make use of.
| AspectEngineBuilderBase ()
Default constructor which uses the ILoggerFactory implementation returned by LoggerFactory#getILoggerFactory().
| |
| AspectEngineBuilderBase (ILoggerFactory loggerFactory)
Construct a new instance using the ILoggerFactory supplied. More...
| |
| TBuilder | setProperties (Set< AspectPropertyMetaData > set)
Configure the properties that the engine will populate in the response. More...
|
| TBuilder | setProperty (String s)
Add a property to the list of properties that the engine will populate in the response. More...
|
| TBuilder | setProperty (AspectPropertyMetaData aspectProperty)
Add a property to the list of properties that the engine will populate in the response. More...
|
| TBuilder | setLazyLoading (LazyLoadingConfiguration configuration)
Configure lazy loading of results. More...
|
| TBuilder | setCache (CacheConfiguration cacheConfiguration)
Configure the results cache that will be used by the Pipeline to cache results from this engine. More...
|
| List< String > | getProperties ()
Get the list of properties that have been added to the builder. More...
|
| void | configureEngine (TEngine engine) throws Exception
Called by the buildEngine() method to handle configuration of the engine after it is built. More...
|
| 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 () throws Exception
Build an engine using the configured options. More...
|
| fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.AspectEngineBuilderBase | ( | ILoggerFactory | loggerFactory | ) |
Construct a new instance using the ILoggerFactory supplied.
| TEngine fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.buildEngine | ( | ) | throws Exception |
Build 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.
| void fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.configureEngine | ( | TEngine | engine | ) | throws Exception |
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.
| List<String> fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.getProperties | ( | ) |
Get 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.
| abstract TEngine fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.newEngine | ( | List< String > | properties | ) |
Called by the buildEngine() method to handle creation of the engine instance.
| void fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.preCreateEngine | ( | ) |
Called by the buildEngine() method to handle anything that needs doing before the engine is built.
By default, nothing needs to be done.
| 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.
| TBuilder fiftyone.pipeline.engines.flowelements.AspectEngineBuilderBase< TBuilder extends AspectEngineBuilderBase< TBuilder, TEngine, TEngine extends AspectEngine >.setLazyLoading | ( | LazyLoadingConfiguration | configuration | ) |
Configure lazy loading of results.
| 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.
| 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.
| 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.
