51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.core.data.ElementPropertyMetaData Interface Reference

Detailed Description

Defines a property that can be returned by a FlowElement.

This is stored in the element itself, so if a property is not included for some reason (e.g. not in a data file, or excluded from config) then the engine still has knowledge of its existence.

An ElementPropertyMetaData is a property of an Element of a request. E.g. ‘HardwareModel’ is a property of the ‘Device’ aspect. They define meta-data such as property name, data type, the data file types the property is present in and a flag indicating if the property is disabled.

Inheritance diagram for fiftyone.pipeline.core.data.ElementPropertyMetaData:

[legend]

Public Member Functions

String  getName ()
Get the name of the property. More...
FlowElement  getElement ()
Get the element which returns this property. More...
String  getCategory ()
The category the property belongs to. More...
Class  getType ()
Get the type of data which the property refers to e.g. More...
boolean  isAvailable ()
Get whether or not the property is available in the results // todo. More...
List< ElementPropertyMetaData >  getItemProperties ()
This is only relevant where Type is a collection of complex objects. More...
boolean  getDelayExecution ()
Only relevant if the type is JavaScript. More...
List< String >  getEvidenceProperties ()
Get the names of any JavaScript properties that, when executed, will obtain additional evidence that can help in determining the value of this property. More...

Member Function Documentation

◆ getDelayExecution()

boolean fiftyone.pipeline.core.data.ElementPropertyMetaData.getDelayExecution ( )

Only relevant if the type is JavaScript.

Defaults to false. If set to true then the JavaScript in this property will not be executed automatically on the client device. This is used where executing the JavaScript would result in undesirable behavior. For example, attempting to access the location of the device will cause the browser to show a pop-up confirming if the user is happy too allow the website access to their location. In general, we don't want this to happen immediately when a user enters a website, but when they try to use a feature that requires location data (e.g. show restaurants near me).

Returns
true if execution should be delayed

Implemented in fiftyone.pipeline.core.data.ElementPropertyMetaDataDefault.

◆ getEvidenceProperties()

List<String> fiftyone.pipeline.core.data.ElementPropertyMetaData.getEvidenceProperties ( )

Get the names of any JavaScript properties that, when executed, will obtain additional evidence that can help in determining the value of this property.

For example, the ScreenPixelsWidthJavaScript property will get the pixel width of the client-device's screen. This is used to update the ScreenPixelsWidth property. As such, ScreenPixelsWidth will have ScreenPixelWidthJavaScript in its list of evidence properties.

Returns
list of evidence properties

Implemented in fiftyone.pipeline.core.data.ElementPropertyMetaDataDefault.

◆ getItemProperties()

List<ElementPropertyMetaData> fiftyone.pipeline.core.data.ElementPropertyMetaData.getItemProperties ( )

This is only relevant where Type is a collection of complex objects.

It contains a list of the property meta-data for the items in the value for this property. For example, if this meta-data instance represents a list of hardware devices, ItemProperties will contain a list of the meta-data for properties available on each hardware device element within that list.

Implemented in fiftyone.pipeline.core.data.ElementPropertyMetaDataDefault.