51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.engines.fiftyone.data.ComponentMetaData Interface Reference

Detailed Description

Meta data relating to a component of an Engine's results e.g.

Hardware.

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

[legend]

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

[legend]

Public Member Functions

byte  getComponentId ()
Get the unique Id of the component. More...
String  getName ()
Get the name of the component. More...
ProfileMetaData  getDefaultProfile ()
Get the default profile which is used by the Engine for this component. More...
Iterable< FiftyOneAspectPropertyMetaData >  getProperties ()
List of the properties which come under the umbrella of this component. More...
FiftyOneAspectPropertyMetaData  getProperty (String propertyName)
Get the property from the component which has the name provided. More...

Member Function Documentation

◆ getComponentId()

byte fiftyone.pipeline.engines.fiftyone.data.ComponentMetaData.getComponentId ( )

Get the unique Id of the component.

Returns
unique component id

◆ getDefaultProfile()

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

Get the default profile which is used by the Engine for this component.

Returns
default profile for this component

◆ getName()

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

Get the name of the component.

Returns
component name

◆ getProperties()

Iterable<FiftyOneAspectPropertyMetaData> fiftyone.pipeline.engines.fiftyone.data.ComponentMetaData.getProperties ( )

List of the properties which come under the umbrella of this component.

Returns
list of properties

◆ getProperty()

FiftyOneAspectPropertyMetaData fiftyone.pipeline.engines.fiftyone.data.ComponentMetaData.getProperty ( String   propertyName )

Get the property from the component which has the name provided.

Null is returned if the component does not contain a property with the name provided.

Parameters
propertyName - name of the property to return
Returns
the property or null if not in this component