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

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