Heracles.ts

@hydra-cg/heracles.ts > MappingsBuilder

Class: MappingsBuilder

Provides a builder for IIriTemplate variable mapping values.

Hierarchy

MappingsBuilder

Index

Constructors

Properties

Accessors

Methods


Constructors

constructor

new MappingsBuilder(mappings: MappingsCollection): MappingsBuilder

Defined in DataModel/MappingsBuilder.ts:23

Initializes a new instance of the MappingBuilder class.

Parameters:

Name Type Description
mappings MappingsCollection IRI template variable mappings collection.

Returns: MappingsBuilder


Properties

<Private> mappings

● mappings: MappingsCollection

Defined in DataModel/MappingsBuilder.ts:9


<Private> result

● result: IDictionary<string>

Defined in DataModel/MappingsBuilder.ts:10


Accessors

variableMappings

get variableMappings(): IDictionary<string>

Defined in DataModel/MappingsBuilder.ts:16

Gets variable mappings in form of variable name - property IRI pairs.

Returns: IDictionary<string>


Methods

complete

complete(): IDictionary<string>

Defined in DataModel/MappingsBuilder.ts:66

Completes the variable values mappings in form of variable name - serialized value pairs.

Returns: IDictionary<string>


withProperty

withProperty(property: string): PropertyMapping

Defined in DataModel/MappingsBuilder.ts:39

Allows to add an IRI property value.

Parameters:

Name Type Description
property string IRI of the property to be filled with value.

Returns: PropertyMapping


withVariable

withVariable(variableName: string): PropertyMapping

Defined in DataModel/MappingsBuilder.ts:53

Allows to add a direct variable value.

Parameters:

Name Type
variableName string

Returns: PropertyMapping