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 java.util.Map;
  24 import lombok.AccessLevel;
  25 import lombok.Getter;
  26 import lombok.Setter;
  27 import org.antlr.v4.runtime.BaseErrorListener;
  28 import org.antlr.v4.runtime.CharStreams;
  29 import org.antlr.v4.runtime.CommonTokenStream;
  30 import org.antlr.v4.runtime.RecognitionException;
  31 import org.antlr.v4.runtime.Recognizer;
  32 import org.onap.cps.cpspath.parser.antlr4.CpsPathLexer;
  33 import org.onap.cps.cpspath.parser.antlr4.CpsPathParser;
  34
  35 @Getter
  36 @Setter(AccessLevel.PACKAGE)
  37 public class CpsPathQuery {
  38
  39     private CpsPathQueryType cpsPathQueryType;
  40     private String xpathPrefix;
  41     private String leafName;
  42     private Object leafValue;
  43     private String descendantName;
  44     private Map<String, Object> leavesData;
  45     private String ancestorSchemaNodeIdentifier = "";
  46
  47     /**
  48      * Returns a cps path query.
  49      *
  50      * @param cpsPathSource cps path
  51      * @return a CpsPathQuery object.
  52      */
  53     public static CpsPathQuery createFrom(final String cpsPathSource) {
  54         final var inputStream = CharStreams.fromString(cpsPathSource);
  55         final var cpsPathLexer = new CpsPathLexer(inputStream);
  56         final var cpsPathParser = new CpsPathParser(new CommonTokenStream(cpsPathLexer));
  57         cpsPathParser.addErrorListener(new BaseErrorListener() {
  58             @Override
  59             public void syntaxError(final Recognizer<?, ?> recognizer, final Object offendingSymbol, final int line,
  60                                     final int charPositionInLine, final String msg, final RecognitionException e) {
  61                 throw new IllegalStateException("failed to parse at line " + line + " due to " + msg, e);
  62             }
  63         });
  64         final var cpsPathBuilder = new CpsPathBuilder();
  65         cpsPathParser.addParseListener(cpsPathBuilder);
  66         cpsPathParser.cpsPath();
  67         return cpsPathBuilder.build();
  68     }
  69
  70     /**
  71      * Has ancestor axis been populated.
  72      *
  73      * @return boolean value.
  74      */
  75     public boolean hasAncestorAxis() {
  76         return !(ancestorSchemaNodeIdentifier.isEmpty());
  77     }
  78
  79 }