aboutsummaryrefslogtreecommitdiffstats
path: root/tools/model-generator/src/main/java/org/onap/policy/apex/tools/model/generator/KeyInfoGetter.java
blob: cb68db3007a8e38f1459db6da5b2d3772d92000b (plain)
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.tools.model.generator;

import lombok.AllArgsConstructor;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo;
import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;

/**
 * Getter methods for policy keys.
 *
 * @author John Keeney (john.keeney@ericsson.com)
 */
@AllArgsConstructor
public class KeyInfoGetter {

    /** The policy model for the getters. */
    private final AxPolicyModel model;

    /**
     * Returns the key name as string.
     *
     * @param key the key to transform
     * @return key name as string, null if key was null
     */
    public String getName(final AxArtifactKey key) {
        if (key == null) {
            return null;
        }
        return key.getName();
    }

    /**
     * Returns the version of an artifact key.
     *
     * @param key the key to extract version from
     * @return version of the key, null if key was null
     */
    public String getVersion(final AxArtifactKey key) {
        if (key == null) {
            return null;
        }
        return key.getVersion();
    }

    /**
     * Returns the parent name for the key.
     *
     * @param key the key to process
     * @return parent name, null if key was null
     */
    public String getPName(final AxReferenceKey key) {
        if (key == null) {
            return null;
        }
        return key.getParentKeyName();
    }

    /**
     * Returns the parent version for the key.
     *
     * @param key the key to process
     * @return parent version, null if key was null
     */
    public String getPVersion(final AxReferenceKey key) {
        if (key == null) {
            return null;
        }
        return key.getParentKeyVersion();
    }

    /**
     * Returns the local name for the key.
     *
     * @param key the key to process
     * @return local name, null if key was null
     */
    public String getLName(final AxReferenceKey key) {
        if (key == null) {
            return null;
        }
        return key.getLocalName();
    }

    /**
     * Returns the local name of the parent for the key.
     *
     * @param key the key to process
     * @return local name of the parent, null if key was null
     */
    public String getPlName(final AxReferenceKey key) {
        if (key == null) {
            return null;
        }
        return key.getParentLocalName();
    }

    /**
     * Returns the UUID of an artifact key.
     *
     * @param key the key to extract version from
     * @return UUID of the key, null if key was null
     */
    public String getUuid(final AxArtifactKey key) {
        if (key == null) {
            return null;
        }
        final AxKeyInfo ki = model.getKeyInformation().get(key);
        if (ki == null || ki.getUuid() == null) {
            return null;
        }
        return ki.getUuid().toString();
    }

    /**
     * Returns the description of an artifact key.
     *
     * @param key the key to extract version from
     * @return description of the key, null if key was null
     */
    public String getDesc(final AxArtifactKey key) {
        if (key == null) {
            return null;
        }
        final AxKeyInfo ki = model.getKeyInformation().get(key);
        if (ki == null || ki.getDescription() == null) {
            return null;
        }
        return ki.getDescription();
    }
}