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

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