DmrSegmentGenerator (ecp-parent 1.27.0-SNAPSHOT API)

All Known Implementing Classes:

FeaturePathDmrSegmentGenerator, IndexDmrSegmentGenerator, MappingDmrSegmentGenerator, TableDmrSegmentGenerator
```
public interface DmrSegmentGenerator
```
Implement this to provide segment generation for one or more types of domain model references.

Author:

Lucas Koehler

Field Summary

Fields
Modifier and Type Field Description

static double NOT_APPLICABLE
The value that expresses that a DmrSegmentGenerator is not applicable for a VDomainModelReference.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.List<VDomainModelReferenceSegment>`	`generateSegments(VDomainModelReference reference)`	Takes a `VDomainModelReference` and generates the list of equivalent `DMR Segments`.
`double`	`isApplicable(VDomainModelReference reference)`	Returns a double that expresses if and how suitable this tester is for the given `VDomainModelReference`.

- Field Detail
  - NOT_APPLICABLE
```
static final double NOT_APPLICABLE
```
    The value that expresses that a DmrSegmentGenerator is not applicable for a VDomainModelReference.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isApplicable
```
double isApplicable(VDomainModelReference reference)
```
    Returns a double that expresses if and how suitable this tester is for the given VDomainModelReference.
    
    Parameters:
    
    reference - The VDomainModelReference
    
    Returns:
    
    The value indicating how suitable this tester is, NOT_APPLICABLE if it can't work with the given VDomainModelReference.
  - generateSegments
```
java.util.List<VDomainModelReferenceSegment> generateSegments(VDomainModelReference reference)
```
    Takes a VDomainModelReference and generates the list of equivalent DMR Segments. Equivalent means that a DMR using the generated segments resolves exactly the same as the given DMR.
    The segment generation is side-effect free. This means neither the given DMR nor any of its contained or referenced elements is changed.
    
    Parameters:
    
    reference - The VDomainModelReference to generate the segments for
    
    Returns:
    
    The list of generated segments; might return an empty list if the given DMR does not specify any path but never null