summaryrefslogtreecommitdiffstats
path: root/config-lib/src/main/java/com/yahoo/config/ModelReference.java
blob: 7f7082384af1d72ed68923ae6c21624e2a21736d (plain) (blame)
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.config;

import java.io.File;
import java.nio.file.Path;
import java.util.Objects;
import java.util.Optional;

/**
 * An immutable reference to a model.
 * This is a file path when read by a client but is set in a config instance either as a
 * path, url or id resolved to an url during deployment.
 *
 * @author bratseth
 */
public class ModelReference {

    // At least one of these are set
    private final Optional<String> modelId;
    private final Optional<UrlReference> url;
    private final Optional<FileReference> path;

    public ModelReference(Optional<String> modelId,
                          Optional<UrlReference> url,
                          Optional<FileReference> path) {
        if (modelId.isEmpty() && url.isEmpty() && path.isEmpty())
            throw new IllegalArgumentException("A model reference must have either a model id, url or path");
        this.modelId = modelId;
        this.url = url;
        this.path = path;
    }

    public Optional<String> modelId() { return modelId; }
    public Optional<UrlReference> url() { return url; }
    public Optional<FileReference> path() { return path; }

    public ModelReference withModelId(Optional<String> modelId) {
        return new ModelReference(modelId, url, path);
    }

    public ModelReference withUrl(Optional<UrlReference> url) {
        return new ModelReference(modelId, url, path);
    }

    public ModelReference withPath(Optional<FileReference> path) {
        return new ModelReference(modelId, url, path);
    }

    /** Returns the path to the file containing this model, or null if not available. */
    public Path value() {
        if (url.isPresent() && new File(url.get().value()).exists())
            return Path.of(url.get().value());
        if (path.isPresent())
            return Path.of(path.get().value());
        return null;
    }

    @Override
    public boolean equals(Object o) {
        if ( ! (o instanceof ModelReference other)) return false;
        if ( ! this.modelId.equals(other.modelId)) return false;
        if ( ! this.url.equals(other.url)) return false;
        if ( ! this.path.equals(other.path)) return false;
        return true;
    }

    @Override
    public int hashCode() {
        return Objects.hash(modelId, url, path);
    }

    /** Returns this on the format accepted by valueOf */
    @Override
    public String toString() {
        return modelId.orElse("") + " " +
               url.map(v -> v.value()).orElse("") + " " +
               path.map(v -> v.value()).orElse("");
    }

    /** Creates a model reference having a model id only. */
    public static ModelReference fromModelId(String modelId) {
        return new ModelReference(Optional.of(modelId), Optional.empty(), Optional.empty());
    }

    /** Creates a model reference having a url only. */
    public static ModelReference fromUrl(String url) {
        return new ModelReference(Optional.empty(), Optional.of(new UrlReference(url)), Optional.empty());
    }

    /** Creates a model reference having a path only. */
    public static ModelReference fromPath(String path) {
        return new ModelReference(Optional.empty(), Optional.empty(), Optional.of(new FileReference(path)));
    }

    /** Creates a model reference having a path only. */
    public static ModelReference valueOf(Path path) {
        return fromPath(path.toString());
    }

    /**
     * Creates a model reference from a three-part string on the form
     * <code>modelId url path</code>
     * Each of the elements are either a value not containing space, or empty represented by "".
     */
    public static ModelReference valueOf(String s) {
        String[] parts = s.split(" ");
        if (parts.length != 3)
            throw new IllegalArgumentException("Expected a config with exactly three space-separated parts, but got '" + s + "'");
        return new ModelReference(parts[0].equals("") ? Optional.empty() : Optional.of(parts[0]),
                                  parts[1].equals("") ? Optional.empty() : Optional.of(new UrlReference(parts[1])),
                                  parts[2].equals("") ? Optional.empty() : Optional.of(new FileReference(parts[2])));

    }

}