fiftyone.pipeline.cloudrequestengine.flowelements

Class CloudAspectEngineBase<TData extends AspectData>

java.lang.Object

fiftyone.pipeline.core.flowelements.FlowElementBase<TData,TProperty>

fiftyone.pipeline.engines.flowelements.AspectEngineBase<TData,AspectPropertyMetaData>

fiftyone.pipeline.cloudrequestengine.flowelements.CloudAspectEngineBase<TData>

All Implemented Interfaces:

fiftyone.pipeline.core.flowelements.FlowElement<TData,AspectPropertyMetaData>, AspectEngine<TData,AspectPropertyMetaData>, CloudAspectEngine<TData,AspectPropertyMetaData>, AutoCloseable

Direct Known Subclasses:

PropertyKeyedCloudEngineBase

public abstract class CloudAspectEngineBase<TData extends AspectData>
extends AspectEngineBase<TData,AspectPropertyMetaData>
implements CloudAspectEngine<TData,AspectPropertyMetaData>

Base class for 51Degrees cloud aspect engines. Contains functionality for getting property meta-data and exposing that information to callers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CloudAspectEngineBase.RequestEngineAccessor Internal class that is used to retrieve the CloudRequestEngine that will be making requests of behalf of this engine.

Nested classes/interfaces inherited from class fiftyone.pipeline.core.flowelements.FlowElementBase

fiftyone.pipeline.core.flowelements.FlowElementBase.DataFactoryInternal<T extends fiftyone.pipeline.core.data.ElementData>, fiftyone.pipeline.core.flowelements.FlowElementBase.DataFactorySimple<T extends fiftyone.pipeline.core.data.ElementData>

Nested classes/interfaces inherited from interface fiftyone.pipeline.core.flowelements.FlowElement

fiftyone.pipeline.core.flowelements.FlowElement.DataFactory<T extends fiftyone.pipeline.core.data.ElementData>

Field Summary

Fields inherited from class fiftyone.pipeline.engines.flowelements.AspectEngineBase

cache, missingPropertyService

Fields inherited from class fiftyone.pipeline.core.flowelements.FlowElementBase

logger, typedKey

Constructor Summary

Constructors

Constructor and Description
CloudAspectEngineBase(org.slf4j.Logger logger, fiftyone.pipeline.core.data.factories.ElementDataFactory<TData> aspectDataFactory) Construct a new instance of the CloudAspectEngineBase.

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	createAPVMap(Map<String,Object> cloudData, List<fiftyone.pipeline.core.data.ElementPropertyMetaData> propertyMetaData) Use the supplied cloud data to create a map of AspectPropertyValue instances.
String	getDataSourceTier()
List<AspectPropertyMetaData>	getProperties()
protected CloudAspectEngineBase.RequestEngineAccessor	getRequestEngine() Used to access the CloudRequestEngine that will be making HTTP requests on behalf of this engine.
fiftyone.pipeline.core.typed.TypedKey<TData>	getTypedDataKey()
protected void	setRequestEngine(CloudAspectEngineBase.RequestEngineAccessor requestEngine)

Methods inherited from class fiftyone.pipeline.engines.flowelements.AspectEngineBase

getExecutor, getLazyLoadingConfiguration, managedResourcesCleanup, processEngine, processInternal, setCache, setLazyLoading

Methods inherited from class fiftyone.pipeline.core.flowelements.FlowElementBase

addPipeline, close, close, finalize, getDataFactory, getElementDataKey, getEvidenceKeyFilter, getPipelines, getProperty, isClosed, isConcurrent, process, unmanagedResourcesCleanup

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface fiftyone.pipeline.engines.flowelements.AspectEngine

getExecutor, getLazyLoadingConfiguration, setCache, setLazyLoading

Methods inherited from interface fiftyone.pipeline.core.flowelements.FlowElement

addPipeline, getDataFactory, getElementDataKey, getEvidenceKeyFilter, getProperty, isClosed, isConcurrent, process

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

CloudAspectEngineBase

public CloudAspectEngineBase(org.slf4j.Logger logger,
                             fiftyone.pipeline.core.data.factories.ElementDataFactory<TData> aspectDataFactory)

Construct a new instance of the CloudAspectEngineBase.

Parameters:

logger - logger instance to use for logging

aspectDataFactory - the factory to use when creating a TData instance

Method Detail

getDataSourceTier

public String getDataSourceTier()

Specified by:

getDataSourceTier in interface AspectEngine<TData extends AspectData,AspectPropertyMetaData>

Specified by:

getDataSourceTier in class AspectEngineBase<TData extends AspectData,AspectPropertyMetaData>

getRequestEngine

protected CloudAspectEngineBase.RequestEngineAccessor getRequestEngine()

Used to access the CloudRequestEngine that will be making HTTP requests on behalf of this engine.

Returns:

A RequestEngineAccessor.

setRequestEngine

protected void setRequestEngine(CloudAspectEngineBase.RequestEngineAccessor requestEngine)

getProperties

public List<AspectPropertyMetaData> getProperties()

Specified by:

getProperties in interface fiftyone.pipeline.core.flowelements.FlowElement<TData extends AspectData,AspectPropertyMetaData>

Specified by:

getProperties in class AspectEngineBase<TData extends AspectData,AspectPropertyMetaData>

getTypedDataKey

public fiftyone.pipeline.core.typed.TypedKey<TData> getTypedDataKey()

Specified by:

getTypedDataKey in interface fiftyone.pipeline.core.flowelements.FlowElement<TData extends AspectData,AspectPropertyMetaData>

Overrides:

getTypedDataKey in class AspectEngineBase<TData extends AspectData,AspectPropertyMetaData>

createAPVMap

protected Map<String,Object> createAPVMap(Map<String,Object> cloudData,
                                          List<fiftyone.pipeline.core.data.ElementPropertyMetaData> propertyMetaData)

Use the supplied cloud data to create a map of AspectPropertyValue instances. A new instance of AspectPropertyValue will be created for each value and the value from the cloud data assigned to it. If the value is null, then the code will look for a property in the cloud data with the same name suffixed with 'nullreason'. If it exists, then its value will be used to set the no value message in the new AspectPropertyValue.

Parameters:

cloudData - the cloud data to be processed. Keys are flat property names (i.e. no '.' separators)

propertyMetaData - the meta data for the properties in the data. This will usually be the list from getProperties() but will be different if dealing with sub-properties

Returns:

a map containing the original values converted to AspectPropertyValue instances. Any entries in the source map where the key ends with 'nullreason' will not appear in the output