aai-core/src/main/java/org/onap/aai/parsers/query/QueryParserStrategy.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *    http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.aai.parsers.query;
  22
  23 import java.io.UnsupportedEncodingException;
  24 import java.net.URI;
  25
  26 import javax.ws.rs.core.MultivaluedMap;
  27
  28 import org.onap.aai.exceptions.AAIException;
  29 import org.onap.aai.introspection.Introspector;
  30 import org.onap.aai.introspection.Loader;
  31 import org.onap.aai.query.builder.QueryBuilder;
  32
  33 /**
  34  * The Class QueryParserStrategy.
  35  */
  36 public abstract class QueryParserStrategy {
  37
  38     protected Loader loader = null;
  39
  40     protected QueryBuilder builder = null;
  41
  42     /**
  43      * Instantiates a new query parser strategy.
  44      *
  45      * @param loader the loader
  46      * @param builder the builder
  47      */
  48     public QueryParserStrategy(Loader loader, QueryBuilder builder) {
  49
  50         this.loader = loader;
  51         this.builder = builder;
  52     }
  53
  54     /**
  55      * Builds the URI parser.
  56      *
  57      * @param uri the uri
  58      * @return the query parser
  59      * @throws UnsupportedEncodingException the unsupported encoding exception
  60      * @throws AAIException the AAI exception
  61      */
  62     public abstract QueryParser buildURIParser(URI uri) throws UnsupportedEncodingException, AAIException;
  63
  64     /**
  65      * Builds the URI parser.
  66      *
  67      * @param uri the uri
  68      * @param queryParams the query params
  69      * @return the query parser
  70      * @throws UnsupportedEncodingException the unsupported encoding exception
  71      * @throws AAIException the AAI exception
  72      */
  73     public abstract QueryParser buildURIParser(URI uri, MultivaluedMap<String, String> queryParams)
  74             throws UnsupportedEncodingException, AAIException;
  75
  76     /**
  77      * Builds the relationship parser.
  78      *
  79      * @param obj the obj
  80      * @return the query parser
  81      * @throws UnsupportedEncodingException the unsupported encoding exception
  82      * @throws AAIException the AAI exception
  83      */
  84     public abstract QueryParser buildRelationshipParser(Introspector obj)
  85             throws UnsupportedEncodingException, AAIException;
  86
  87     /**
  88      * Builds an ObjectNameQueryParser.
  89      *
  90      * @param objName - the name of the object type as used in the database
  91      * @return
  92      */
  93     public abstract QueryParser buildObjectNameParser(String objName);
  94 }