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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 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.cps.cpspath.parser;
  22
  23 import static org.onap.cps.cpspath.parser.CpsPathPrefixType.ABSOLUTE;
  24
  25 import java.util.Map;
  26 import lombok.AccessLevel;
  27 import lombok.Getter;
  28 import lombok.Setter;
  29 import org.antlr.v4.runtime.BaseErrorListener;
  30 import org.antlr.v4.runtime.CharStreams;
  31 import org.antlr.v4.runtime.CommonTokenStream;
  32 import org.antlr.v4.runtime.RecognitionException;
  33 import org.antlr.v4.runtime.Recognizer;
  34 import org.onap.cps.cpspath.parser.antlr4.CpsPathLexer;
  35 import org.onap.cps.cpspath.parser.antlr4.CpsPathParser;
  36
  37 @Getter
  38 @Setter(AccessLevel.PACKAGE)
  39 public class CpsPathQuery {
  40
  41     private String xpathPrefix;
  42     private CpsPathPrefixType cpsPathPrefixType = ABSOLUTE;
  43     private String descendantName;
  44     private Map<String, Object> leavesData;
  45     private String ancestorSchemaNodeIdentifier = "";
  46     private String textFunctionConditionLeafName;
  47     private String textFunctionConditionValue;
  48
  49     /**
  50      * Returns a cps path query.
  51      *
  52      * @param cpsPathSource cps path
  53      * @return a CpsPathQuery object.
  54      */
  55     public static CpsPathQuery createFrom(final String cpsPathSource) {
  56         final var inputStream = CharStreams.fromString(cpsPathSource);
  57         final var cpsPathLexer = new CpsPathLexer(inputStream);
  58         final var cpsPathParser = new CpsPathParser(new CommonTokenStream(cpsPathLexer));
  59         cpsPathParser.addErrorListener(new BaseErrorListener() {
  60             @Override
  61             public void syntaxError(final Recognizer<?, ?> recognizer, final Object offendingSymbol, final int line,
  62                                     final int charPositionInLine, final String msg, final RecognitionException e) {
  63                 throw new IllegalStateException("failed to parse at line " + line + " due to " + msg, e);
  64             }
  65         });
  66         final var cpsPathBuilder = new CpsPathBuilder();
  67         cpsPathParser.addParseListener(cpsPathBuilder);
  68         cpsPathParser.cpsPath();
  69         return cpsPathBuilder.build();
  70     }
  71
  72     /**
  73      * Has ancestor axis been included in cpsPath.
  74      *
  75      * @return boolean value.
  76      */
  77     public boolean hasAncestorAxis() {
  78         return !(ancestorSchemaNodeIdentifier.isEmpty());
  79     }
  80
  81     /**
  82      * Have leaf value conditions been included in cpsPath.
  83      *
  84      * @return boolean value.
  85      */
  86     public boolean hasLeafConditions() {
  87         return leavesData != null;
  88     }
  89
  90     /**
  91      * Has text function condition been included in cpsPath.
  92      *
  93      * @return boolean value.
  94      */
  95     public boolean hasTextFunctionCondition() {
  96         return textFunctionConditionLeafName != null;
  97     }
  98
  99 }