Detailed Description
Abstract base class for AspectData which overrides the.
- See also
- Specification
Inheritance diagram for fiftyone.pipeline.engines.data.AspectDataBase:
Collaboration diagram for fiftyone.pipeline.engines.data.AspectDataBase:
Public Member Functions | |
| AspectDataBase (Logger logger, FlowData flowData, AspectEngine<? extends AspectData, ? extends AspectPropertyMetaData > engine) | |
Constructs a new instance with a non-thread-safe, case-insensitive Map as the underlying storage. | |
| AspectDataBase (Logger logger, FlowData flowData, AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > engine, MissingPropertyService missingPropertyService) | |
Constructs a new instance with a non-thread-safe, case-insensitive Map as the underlying storage. | |
| AspectDataBase (Logger logger, FlowData flowData, AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > engine, MissingPropertyService missingPropertyService, Map< String, Object > map) | |
Constructs a new instance with a custom Map as the underlying storage. | |
| List< AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > > | getEngines () |
| Get the engines that generated the data withing this data instance. | |
| Future<?> | getProcessFuture () |
If the engine is configured for lazy loading, this property returns a Future that will complete once the engine has finished processing. | |
| void | addEngine (AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > engine) |
| Add an engine to the list of engines which have generated the data within this instance. | |
| void | addProcessCallable (ProcessCallable runnable) |
Add a callable which will run a AspectEngine#process(FlowData) method to populate this instance. | |
| Map< String, Object > | asKeyMap () |
Get the data contained in this instance as a read only Map. | |
| Object | get (String propertyName) throws PropertyMissingException |
Gets the value stored using the specified key with full checks against the MissingPropertyService. | |
Public Member Functions inherited from fiftyone.pipeline.core.data.ElementDataBase | |
| ElementDataBase (Logger logger, FlowData flowData) | |
Constructs a new instance with a non-thread-safe, case-insensitive Map as the underlying storage. | |
| ElementDataBase (Logger logger, FlowData flowData, Map< String, Object > data) | |
Constructs a new instance with a custom Map as the underlying storage. | |
| Pipeline | getPipeline () |
Get the Pipeline instance which this instance is associated with. | |
| void | setPipeline (Pipeline pipeline) |
Set the Pipeline instance which this instance is associated with. | |
Public Member Functions inherited from fiftyone.pipeline.core.data.DataBase | |
| DataBase (Logger logger) | |
Construct a new instance with the default case insensitive Map as the underlying storage. | |
| DataBase (Logger logger, Map< String, Object > data) | |
Construct a new instance with a custom implementation of Map as the underlying storage. | |
| void | put (String key, Object value) |
| Set the value stored using the specified key. | |
| void | populateFromMap (Map< String, Object > values) |
| Use the values in the specified map to populate this data instance. | |
Additional Inherited Members | |
Protected Attributes inherited from fiftyone.pipeline.core.data.DataBase | |
| final Logger | logger |
Constructor & Destructor Documentation
◆ AspectDataBase() [1/3]
| fiftyone.pipeline.engines.data.AspectDataBase.AspectDataBase | ( | Logger | logger, |
| FlowData | flowData, | ||
| AspectEngine<? extends AspectData, ? extends AspectPropertyMetaData > | engine ) |
◆ AspectDataBase() [2/3]
| fiftyone.pipeline.engines.data.AspectDataBase.AspectDataBase | ( | Logger | logger, |
| FlowData | flowData, | ||
| AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > | engine, | ||
| MissingPropertyService | missingPropertyService ) |
Constructs a new instance with a non-thread-safe, case-insensitive Map as the underlying storage.
- Parameters
-
logger used for logging flowData the FlowDatainstance this element data will be associated withengine the engine which created the instance missingPropertyService service used to determine the reason for a property value being missing
◆ AspectDataBase() [3/3]
| fiftyone.pipeline.engines.data.AspectDataBase.AspectDataBase | ( | Logger | logger, |
| FlowData | flowData, | ||
| AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > | engine, | ||
| MissingPropertyService | missingPropertyService, | ||
| Map< String, Object > | map ) |
Constructs a new instance with a custom Map as the underlying storage.
- Parameters
-
logger used for logging flowData the FlowDatainstance this element data will be associated withengine the engine which created the instance missingPropertyService service used to determine the reason for a property value being missing map the custom Mapimplementation to use as the underlying storage
Member Function Documentation
◆ addEngine()
| void fiftyone.pipeline.engines.data.AspectDataBase.addEngine | ( | AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > | engine | ) |
Add an engine to the list of engines which have generated the data within this instance.
- Parameters
-
engine engine adding data
◆ addProcessCallable()
| void fiftyone.pipeline.engines.data.AspectDataBase.addProcessCallable | ( | ProcessCallable | runnable | ) |
Add a callable which will run a AspectEngine#process(FlowData) method to populate this instance.
The property accessors will only complete once all such tasks have completed.
- Parameters
-
runnable processing runnable
◆ asKeyMap()
| Map< String, Object > fiftyone.pipeline.engines.data.AspectDataBase.asKeyMap | ( | ) |
Get the data contained in this instance as a read only Map.
- Returns
- the data
Reimplemented from fiftyone.pipeline.core.data.DataBase.
◆ get()
| Object fiftyone.pipeline.engines.data.AspectDataBase.get | ( | String | propertyName | ) | throws PropertyMissingException |
Gets the value stored using the specified key with full checks against the MissingPropertyService.
- Parameters
-
propertyName to get the value for
- Returns
- value of the property
- Exceptions
-
PropertyMissingException the property was not found
Reimplemented from fiftyone.pipeline.core.data.DataBase.
◆ getEngines()
| List< AspectEngine<? extends AspectData,? extends AspectPropertyMetaData > > fiftyone.pipeline.engines.data.AspectDataBase.getEngines | ( | ) |
Get the engines that generated the data withing this data instance.
- Returns
- engines which generated the data
Implements fiftyone.pipeline.engines.data.AspectData.
◆ getProcessFuture()
| Future<?> fiftyone.pipeline.engines.data.AspectDataBase.getProcessFuture | ( | ) |
If the engine is configured for lazy loading, this property returns a Future that will complete once the engine has finished processing.
Otherwise, it will be null.
- Returns
- lazy loading future or null
Implements fiftyone.pipeline.engines.data.AspectData.
