Class LayeringProjectDataProviderEngineFactory<SupportedProjectInterfaces>Abstract

Abstract class with partial implementation of IProjectDataProviderEngineFactory specifically for Layering PDPFs. You can extend this class to make creating a Layering PDPF easier.

Extending this class automatically fulfills the special requirements for Layering PDPfs, so we highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

Type Parameters

Constructors

Properties

pdpfId: string
pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

projectInterfacesToLayerOver: undefined | string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included in the available projects this Layering PDPF provides. This is used as ProjectMetadataFilterOptions.includeProjectInterfaces when determining what available projects this layering PDPF supports. You should list here all combinations of projectInterfaces your Layering PDPs require to make sure this layering PDPF announces that it supports the right projects.

See ProjectMetadataFilterOptions.includeProjectInterfaces for more information on how to use this field.

projectInterfacesToLayerOver: ['one', ['two', 'three']];

This layering PDPF will announce that it supports projects whose projectInterfaces fulfill at least one of the following conditions (At least one entry in the array must match) and will provide providedProjectInterfaces for those projects:

  • Include one
  • Include both two and three.
providedProjectInterfaces: SupportedProjectInterfaces

The list of projectInterfaces that this layering PDPF provides on top of existing projects.

providedProjectInterfaces: ['four', 'five'];

This layering PDPF will announce that its provides the projectInterfaces four and five for projects that match projectInterfacesToLayerOver.

Methods