51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.engines.fiftyone.data.ProfileMetaData Interface Reference

Detailed Description

Meta data relating to a profile within the data set.

Inheritance diagram for fiftyone.pipeline.engines.fiftyone.data.ProfileMetaData:

[legend]

Collaboration diagram for fiftyone.pipeline.engines.fiftyone.data.ProfileMetaData:

[legend]

Public Member Functions

int  getProfileId ()
Get the unique id of the profile. More...
Iterable< ValueMetaData >  getValues ()
Get the values which are defined in the profile (for some Engines multiple profiles are required to build a full set of results). More...
Iterable< ValueMetaData >  getValues (String propertyName)
Gets the values associated with the profile and the property name. More...
ValueMetaData  getValue (String propertyName, String valueName)
If there is a value for the profile with the property name and value then return an instance of it. More...
ComponentMetaData  getComponent ()
The component which the profile belongs to. More...
String  getName ()
The name of the profile. More...

Member Function Documentation

◆ getComponent()

ComponentMetaData fiftyone.pipeline.engines.fiftyone.data.ProfileMetaData.getComponent ( )

The component which the profile belongs to.

Returns
the component for the profile

◆ getName()

String fiftyone.pipeline.engines.fiftyone.data.ProfileMetaData.getName ( )

The name of the profile.

Usually indicates the type of device.

Returns
name of the profile

◆ getProfileId()

int fiftyone.pipeline.engines.fiftyone.data.ProfileMetaData.getProfileId ( )

Get the unique id of the profile.

Returns
unique id of the profile

◆ getValue()

ValueMetaData fiftyone.pipeline.engines.fiftyone.data.ProfileMetaData.getValue ( String   propertyName,
String   valueName  
)

If there is a value for the profile with the property name and value then return an instance of it.

Parameters
propertyName - to get the value for
valueName - value to look for
Returns
value instance for property and value, or null if it doesn't exist

◆ getValues() [1/2]

Iterable<ValueMetaData> fiftyone.pipeline.engines.fiftyone.data.ProfileMetaData.getValues ( )

Get the values which are defined in the profile (for some Engines multiple profiles are required to build a full set of results).

Returns
values defined in the profile

◆ getValues() [2/2]

Iterable<ValueMetaData> fiftyone.pipeline.engines.fiftyone.data.ProfileMetaData.getValues ( String   propertyName )

Gets the values associated with the profile and the property name.

Parameters
propertyName - to get the values for
Returns
values matching the property