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 lombok.AccessLevel;
  24 import lombok.Getter;
  25 import lombok.NoArgsConstructor;
  26 import lombok.Setter;
  27 import org.antlr.v4.runtime.BaseErrorListener;
  28 import org.antlr.v4.runtime.CharStream;
  29 import org.antlr.v4.runtime.CharStreams;
  30 import org.antlr.v4.runtime.CommonTokenStream;
  31 import org.antlr.v4.runtime.RecognitionException;
  32 import org.antlr.v4.runtime.Recognizer;
  33 import org.onap.cps.cpspath.parser.antlr4.CpsPathLexer;
  34 import org.onap.cps.cpspath.parser.antlr4.CpsPathParser;
  35
  36 @Getter
  37 @Setter
  38 @NoArgsConstructor(access = AccessLevel.PACKAGE)
  39 public class CpsPathUtil {
  40
  41     /**
  42      * Returns a normalized xpath path query.
  43      *
  44      * @param xpathSource xpath
  45      * @return a normalized xpath String.
  46      */
  47     public static String getNormalizedXpath(final String xpathSource) {
  48         final CpsPathBuilder cpsPathBuilder = getCpsPathBuilder(xpathSource);
  49         return cpsPathBuilder.build().getNormalizedXpath();
  50     }
  51
  52     /**
  53      * Returns a cps path query.
  54      *
  55      * @param cpsPathSource cps path
  56      * @return a CpsPathQuery object.
  57      */
  58
  59     public static CpsPathQuery getCpsPathQuery(final String cpsPathSource) {
  60         final CpsPathBuilder cpsPathBuilder = getCpsPathBuilder(cpsPathSource);
  61         return cpsPathBuilder.build();
  62     }
  63
  64     private static CpsPathBuilder getCpsPathBuilder(final String cpsPathSource) {
  65         final CharStream inputStream = CharStreams.fromString(cpsPathSource);
  66         final CpsPathLexer cpsPathLexer = new CpsPathLexer(inputStream);
  67         final CpsPathParser cpsPathParser = new CpsPathParser(new CommonTokenStream(cpsPathLexer));
  68         cpsPathParser.addErrorListener(new BaseErrorListener() {
  69             @Override
  70             public void syntaxError(final Recognizer<?, ?> recognizer, final Object offendingSymbol, final int line,
  71                                     final int charPositionInLine, final String msg, final RecognitionException e) {
  72                 throw new PathParsingException("failed to parse at line " + line + " due to " + msg,
  73                         e == null ? "" : e.getMessage());
  74             }
  75         });
  76         final CpsPathBuilder cpsPathBuilder = new CpsPathBuilder();
  77         cpsPathParser.addParseListener(cpsPathBuilder);
  78         cpsPathParser.cpsPath();
  79         return cpsPathBuilder;
  80     }
  81 }