Implement validation and hierarchical get
[policy/models.git] / models-base / src / main / java / org / onap / policy / models / base / PfConceptGetterImpl.java
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2019-2020 Nordix Foundation.
4  * ================================================================================
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * SPDX-License-Identifier: Apache-2.0
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.policy.models.base;
22
23 import java.util.NavigableMap;
24 import java.util.Set;
25 import java.util.TreeSet;
26
27 import org.onap.policy.common.utils.validation.Assertions;
28
29 /**
30  * Implements concept getting from navigable maps.
31  *
32  * @param <C> the type of concept on which the interface implementation is applied.
33  */
34 public class PfConceptGetterImpl<C> implements PfConceptGetter<C> {
35
36     // The map from which to get concepts
37     private final NavigableMap<PfConceptKey, C> conceptMap;
38
39     /**
40      * Constructor that sets the concept map on which the getter methods in the interface will operate..
41      *
42      * @param conceptMap the concept map on which the method will operate
43      */
44     public PfConceptGetterImpl(final NavigableMap<PfConceptKey, C> conceptMap) {
45         this.conceptMap = conceptMap;
46     }
47
48     @Override
49     public C get(final PfConceptKey conceptKey) {
50         return conceptMap.get(conceptKey);
51     }
52
53     @Override
54     public C get(final String conceptKeyName) {
55         Assertions.argumentNotNull(conceptKeyName, "conceptKeyName may not be null");
56
57         // The very fist key that could have this name
58         final PfConceptKey lowestArtifactKey = new PfConceptKey(conceptKeyName, "0.0.1");
59
60         // Check if we found a key for our name
61         PfConceptKey foundKey = conceptMap.ceilingKey(lowestArtifactKey);
62         if (foundKey == null || !foundKey.getName().equals(conceptKeyName)) {
63             return null;
64         }
65
66         // Look for higher versions of the key
67         do {
68             final PfConceptKey nextkey = conceptMap.higherKey(foundKey);
69             if (nextkey == null || !nextkey.getName().equals(conceptKeyName)) {
70                 break;
71             }
72             foundKey = nextkey;
73         }
74         while (true);
75
76         return conceptMap.get(foundKey);
77     }
78
79     @Override
80     public C get(final String conceptKeyName, final String conceptKeyVersion) {
81         Assertions.argumentNotNull(conceptKeyName, "conceptKeyName may not be null");
82
83         if (conceptKeyVersion != null) {
84             return conceptMap.get(new PfConceptKey(conceptKeyName, conceptKeyVersion));
85         } else {
86             return this.get(conceptKeyName);
87         }
88     }
89
90     @Override
91     public Set<C> getAll(final String conceptKeyName) {
92         return getAll(conceptKeyName, null);
93     }
94
95     @Override
96     public Set<C> getAll(final String conceptKeyName, final String conceptKeyVersion) {
97         final Set<C> returnSet = new TreeSet<>();
98
99         if (conceptKeyName == null) {
100             returnSet.addAll(conceptMap.values());
101             return returnSet;
102         }
103
104         // The very fist key that could have this name
105         final PfConceptKey lowestArtifactKey = new PfConceptKey(conceptKeyName, PfKey.NULL_KEY_VERSION);
106         if (conceptKeyVersion != null) {
107             lowestArtifactKey.setVersion(conceptKeyVersion);
108         }
109
110         // Check if we found a key for our name
111         PfConceptKey foundKey = conceptMap.ceilingKey(lowestArtifactKey);
112         if (foundKey == null || !foundKey.getName().equals(conceptKeyName)) {
113             return returnSet;
114         }
115         returnSet.add(conceptMap.get(foundKey));
116
117         // Look for higher versions of the key
118         do {
119             foundKey = conceptMap.higherKey(foundKey);
120             if (foundKey == null || !foundKey.getName().equals(conceptKeyName)) {
121                 break;
122             }
123             returnSet.add(conceptMap.get(foundKey));
124         }
125         while (true);
126
127         return returnSet;
128     }
129 }