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