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 package org.onap.aai.parsers.query;
  21
  22 import org.onap.aai.exceptions.AAIException;
  23 import org.onap.aai.introspection.Introspector;
  24 import org.onap.aai.introspection.Loader;
  25 import org.onap.aai.query.builder.QueryBuilder;
  26
  27 import javax.ws.rs.core.MultivaluedMap;
  28 import java.io.UnsupportedEncodingException;
  29 import java.net.URI;
  30
  31 /**
  32  * The Class QueryParserStrategy.
  33  */
  34 public abstract class QueryParserStrategy {
  35
  36         protected Loader loader = null;
  37
  38         protected QueryBuilder builder = null;
  39
  40         /**
  41          * Instantiates a new query parser strategy.
  42          *
  43          * @param loader the loader
  44          * @param builder the builder
  45          */
  46         public QueryParserStrategy(Loader loader, QueryBuilder builder) {
  47
  48                 this.loader = loader;
  49                 this.builder = builder;
  50         }
  51
  52         /**
  53          * Builds the URI parser.
  54          *
  55          * @param uri the uri
  56          * @return the query parser
  57          * @throws UnsupportedEncodingException the unsupported encoding exception
  58          * @throws AAIException the AAI exception
  59          */
  60         public abstract QueryParser buildURIParser(URI uri) throws UnsupportedEncodingException, AAIException;
  61
  62         /**
  63          * Builds the URI parser.
  64          *
  65          * @param uri the uri
  66          * @param queryParams the query params
  67          * @return the query parser
  68          * @throws UnsupportedEncodingException the unsupported encoding exception
  69          * @throws AAIException the AAI exception
  70          */
  71         public abstract QueryParser buildURIParser(URI uri,MultivaluedMap<String, String> queryParams) throws UnsupportedEncodingException, AAIException;
  72
  73         /**
  74          * Builds the relationship parser.
  75          *
  76          * @param obj the obj
  77          * @return the query parser
  78          * @throws UnsupportedEncodingException the unsupported encoding exception
  79          * @throws AAIException the AAI exception
  80          */
  81         public abstract QueryParser buildRelationshipParser(Introspector obj) throws UnsupportedEncodingException, AAIException;
  82
  83         /**
  84          * Builds an ObjectNameQueryParser.
  85          *
  86          * @param objName - the name of the object type as used in the database
  87          * @return
  88          */
  89         public abstract QueryParser buildObjectNameParser(String objName);
  90 }