config-model/src/main/java/com/yahoo/vespa/model/content/TopologicalDocumentTypeSorter.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model.content;

import com.yahoo.documentmodel.NewDocumentType;

import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * Class that sorts a list of document types in topological order
 * according to the document references between the types.
 *
 * Document types without any outgoing document references are considered
 * to be first in the topological order.
 *
 * @author geirst
 */
public class TopologicalDocumentTypeSorter {

    private final Map<String, NewDocumentType> unsortedTypes = new LinkedHashMap<>();
    private final Map<String, NewDocumentType> sortedTypes = new LinkedHashMap<>();

    private TopologicalDocumentTypeSorter(Collection<NewDocumentType> documentTypes) {
        documentTypes.forEach(docType -> unsortedTypes.put(docType.getName(), docType));
        unsortedTypes.values().forEach(docType -> depthFirstTraverse(docType));
    }

    private void depthFirstTraverse(NewDocumentType docType) {
        // Note that cycles are not allowed and detected earlier in DocumentGraphValidator.
        if (sortedTypes.containsKey(docType.getName())) {
            return;
        }
        for (NewDocumentType.Name referenceDocTypeName : docType.getDocumentReferences()) {
            NewDocumentType referenceDocType = unsortedTypes.get(referenceDocTypeName.getName());
            depthFirstTraverse(referenceDocType);
        }
        sortedTypes.put(docType.getName(), docType);
    }

    public static List<NewDocumentType> sort(Collection<NewDocumentType> documentTypes) {
        TopologicalDocumentTypeSorter sorter = new TopologicalDocumentTypeSorter(documentTypes);
        return new ArrayList<>(sorter.sortedTypes.values());
    }
}