cps-path-parser/src/main/java/org/onap/cps/cpspath/parser/CpsPathQuery.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 Nordix Foundation
   4  *  Modifications Copyright (C) 2023 TechMahindra Ltd
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.cpspath.parser;
  23
  24 import static org.onap.cps.cpspath.parser.CpsPathPrefixType.ABSOLUTE;
  25
  26 import java.util.List;
  27 import java.util.Map;
  28 import lombok.AccessLevel;
  29 import lombok.Getter;
  30 import lombok.Setter;
  31
  32 @Getter
  33 @Setter(AccessLevel.PACKAGE)
  34 public class CpsPathQuery {
  35
  36     private String xpathPrefix;
  37     private String normalizedParentPath;
  38     private String normalizedXpath;
  39     private List<String> containerNames;
  40     private CpsPathPrefixType cpsPathPrefixType = ABSOLUTE;
  41     private String descendantName;
  42     private Map<String, Object> leavesData;
  43     private String ancestorSchemaNodeIdentifier = "";
  44     private String textFunctionConditionLeafName;
  45     private String textFunctionConditionValue;
  46     private List<String> booleanOperatorsType;
  47
  48     /**
  49      * Returns a cps path query.
  50      *
  51      * @param cpsPathSource cps path
  52      * @return a CpsPathQuery object.
  53      */
  54     public static CpsPathQuery createFrom(final String cpsPathSource) {
  55         return CpsPathUtil.getCpsPathQuery(cpsPathSource);
  56     }
  57
  58     /**
  59      * Has ancestor axis been included in cpsPath.
  60      *
  61      * @return boolean value.
  62      */
  63     public boolean hasAncestorAxis() {
  64         return !(ancestorSchemaNodeIdentifier.isEmpty());
  65     }
  66
  67     /**
  68      * Have leaf value conditions been included in cpsPath.
  69      *
  70      * @return boolean value.
  71      */
  72     public boolean hasLeafConditions() {
  73         return leavesData != null;
  74     }
  75
  76     /**
  77      * Has text function condition been included in cpsPath.
  78      *
  79      * @return boolean value.
  80      */
  81     public boolean hasTextFunctionCondition() {
  82         return textFunctionConditionLeafName != null;
  83     }
  84
  85     /**
  86      * Returns boolean indicating xpath is an absolute path to a list element.
  87      *
  88      * @return true if xpath is an absolute path to a list element
  89      */
  90     public boolean isPathToListElement() {
  91         return cpsPathPrefixType == ABSOLUTE && hasLeafConditions();
  92     }
  93
  94 }