Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 17 | package org.onosproject.yangutils.datamodel; |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 18 | |
| 19 | import java.util.List; |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 20 | import java.util.Set; |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 21 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
| 22 | |
| 23 | /** |
| 24 | * Abstraction of YANG dependency resolution information. Abstracted to obtain the |
| 25 | * resolution information. |
| 26 | */ |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 27 | public interface YangReferenceResolver { |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 28 | |
| 29 | /** |
| 30 | * Returns unresolved resolution list. |
| 31 | * |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 32 | * @param type resolvable type |
| 33 | * @return list of resolution information objects |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 34 | */ |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 35 | List<YangResolutionInfo> getUnresolvedResolutionList(ResolvableType type); |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 36 | |
| 37 | /** |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 38 | * Adds to the resolution list. |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 39 | * |
| 40 | * @param resolutionInfo resolution information |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 41 | * @param type resolvable type |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 42 | */ |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 43 | void addToResolutionList(YangResolutionInfo resolutionInfo, ResolvableType type); |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 44 | |
| 45 | /** |
| 46 | * Creates resolution list. |
| 47 | * |
| 48 | * @param resolutionList resolution list |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 49 | * @param type resolvable type |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 50 | */ |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 51 | void setResolutionList(List<YangResolutionInfo> resolutionList, ResolvableType type); |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 52 | |
| 53 | /** |
| 54 | * Returns unresolved imported list. |
| 55 | * |
| 56 | * @return unresolved imported list |
| 57 | */ |
| 58 | List<YangImport> getImportList(); |
| 59 | |
| 60 | /** |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 61 | * Adds to the import list. |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 62 | * |
| 63 | * @param yangImport import to be added |
| 64 | */ |
| 65 | void addToImportList(YangImport yangImport); |
| 66 | |
| 67 | /** |
| 68 | * Create import list. |
| 69 | * |
| 70 | * @param importList import list |
| 71 | */ |
| 72 | void setImportList(List<YangImport> importList); |
| 73 | |
| 74 | /** |
| 75 | * Returns unresolved include list. |
| 76 | * |
| 77 | * @return unresolved include list |
| 78 | */ |
| 79 | List<YangInclude> getIncludeList(); |
| 80 | |
| 81 | /** |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 82 | * Adds to the include list. |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 83 | * |
| 84 | * @param yangInclude include to be added |
| 85 | */ |
| 86 | void addToIncludeList(YangInclude yangInclude); |
| 87 | |
| 88 | /** |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 89 | * Creates include list. |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 90 | * |
| 91 | * @param includeList include list |
| 92 | */ |
| 93 | void setIncludeList(List<YangInclude> includeList); |
| 94 | |
| 95 | /** |
| 96 | * Returns prefix of resolution root node. |
| 97 | * |
| 98 | * @return prefix resolution root node prefix |
| 99 | */ |
| 100 | String getPrefix(); |
| 101 | |
| 102 | /** |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 103 | * Sets prefix of resolution list root node. |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 104 | * |
| 105 | * @param prefix resolution root node prefix |
| 106 | */ |
| 107 | void setPrefix(String prefix); |
| 108 | |
| 109 | /** |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 110 | * Resolves self file linking. |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 111 | * |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 112 | * @param type resolvable type |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 113 | * @throws DataModelException a violation in data model rule |
| 114 | */ |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 115 | void resolveSelfFileLinking(ResolvableType type) |
| 116 | throws DataModelException; |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 117 | |
| 118 | /** |
| 119 | * Resolves inter file linking. |
| 120 | * |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 121 | * @param type resolvable type |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 122 | * @throws DataModelException a violation in data model rule |
| 123 | */ |
VinodKumarS-Huawei | 2ee9e7e | 2016-06-01 14:30:22 +0530 | [diff] [blame] | 124 | void resolveInterFileLinking(ResolvableType type) |
| 125 | throws DataModelException; |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 126 | |
| 127 | /** |
| 128 | * Adds references to include. |
| 129 | * |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 130 | * @param yangNodeSet YANG node info set |
| 131 | * @throws DataModelException a violation of data model rules |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 132 | */ |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 133 | void addReferencesToIncludeList(Set<YangNode> yangNodeSet) |
| 134 | throws DataModelException; |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 135 | |
| 136 | /** |
| 137 | * Adds references to import. |
| 138 | * |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 139 | * @param yangNodeSet YANG node info set |
| 140 | * @throws DataModelException a violation of data model rules |
Gaurav Agrawal | 0d43bb5 | 2016-05-17 18:06:38 +0530 | [diff] [blame] | 141 | */ |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 142 | void addReferencesToImportList(Set<YangNode> yangNodeSet) |
| 143 | throws DataModelException; |
Gaurav Agrawal | d9d6cc8 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 144 | } |