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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 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 lombok.AccessLevel;
  26 import lombok.Getter;
  27 import lombok.NoArgsConstructor;
  28 import lombok.Setter;
  29 import org.antlr.v4.runtime.BaseErrorListener;
  30 import org.antlr.v4.runtime.CharStream;
  31 import org.antlr.v4.runtime.CharStreams;
  32 import org.antlr.v4.runtime.CommonTokenStream;
  33 import org.antlr.v4.runtime.RecognitionException;
  34 import org.antlr.v4.runtime.Recognizer;
  35 import org.onap.cps.cpspath.parser.antlr4.CpsPathLexer;
  36 import org.onap.cps.cpspath.parser.antlr4.CpsPathParser;
  37
  38 @Getter
  39 @Setter
  40 @NoArgsConstructor(access = AccessLevel.PACKAGE)
  41 public class CpsPathUtil {
  42
  43     /**
  44      * Returns a normalized xpath path query.
  45      *
  46      * @param xpathSource xpath
  47      * @return a normalized xpath String.
  48      */
  49     public static String getNormalizedXpath(final String xpathSource) {
  50         return getCpsPathBuilder(xpathSource).build().getNormalizedXpath();
  51     }
  52
  53     /**
  54      * Returns the parent xpath.
  55      *
  56      * @param xpathSource xpath
  57      * @return the parent xpath String.
  58      */
  59     public static String getNormalizedParentXpath(final String xpathSource) {
  60         return getCpsPathBuilder(xpathSource).build().getNormalizedParentPath();
  61     }
  62
  63
  64     /**
  65      * Returns boolean indicating xpath is an absolute path to a list element.
  66      *
  67      * @param xpathSource xpath
  68      * @return true if xpath is an absolute path to a list element
  69      */
  70     public static boolean isPathToListElement(final String xpathSource) {
  71         final CpsPathQuery cpsPathQuery = getCpsPathBuilder(xpathSource).build();
  72         return cpsPathQuery.getCpsPathPrefixType() == ABSOLUTE && cpsPathQuery.hasLeafConditions();
  73     }
  74
  75     /**
  76      * Returns a cps path query.
  77      *
  78      * @param cpsPathSource cps path
  79      * @return a CpsPathQuery object.
  80      */
  81
  82     public static CpsPathQuery getCpsPathQuery(final String cpsPathSource) {
  83         return getCpsPathBuilder(cpsPathSource).build();
  84     }
  85
  86     private static CpsPathBuilder getCpsPathBuilder(final String cpsPathSource) {
  87         final CharStream inputStream = CharStreams.fromString(cpsPathSource);
  88         final CpsPathLexer cpsPathLexer = new CpsPathLexer(inputStream);
  89         final CpsPathParser cpsPathParser = new CpsPathParser(new CommonTokenStream(cpsPathLexer));
  90         cpsPathParser.addErrorListener(new BaseErrorListener() {
  91             @Override
  92             public void syntaxError(final Recognizer<?, ?> recognizer, final Object offendingSymbol, final int line,
  93                                     final int charPositionInLine, final String msg, final RecognitionException e) {
  94                 throw new PathParsingException("failed to parse at line " + line + " due to " + msg,
  95                         e == null ? "" : e.getMessage());
  96             }
  97         });
  98         final CpsPathBuilder cpsPathBuilder = new CpsPathBuilder();
  99         cpsPathParser.addParseListener(cpsPathBuilder);
 100         cpsPathParser.cpsPath();
 101         return cpsPathBuilder;
 102     }
 103 }