catalog-dao/src/main/java/org/openecomp/sdc/be/dao/api/IBasicDAO.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   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.sdc.be.dao.api;
  22
  23 import fj.data.Either;
  24 import org.openecomp.sdc.be.dao.graph.datatype.GraphNode;
  25 import org.openecomp.sdc.be.dao.neo4j.GraphNeighbourTable;
  26 import org.openecomp.sdc.be.dao.neo4j.Neo4jOperationStatus;
  27 import org.openecomp.sdc.be.datatypes.enums.NodeTypeEnum;
  28
  29 import java.util.List;
  30 import java.util.Map;
  31
  32 public interface IBasicDAO {
  33
  34         /**
  35          * add the content of the graph neighbour table to the graph.
  36          *
  37          * @param graphNeighbourTable
  38          * @param clazz
  39          *            - the type of the object to be returned
  40          * @param nodeType
  41          *            - label of the node
  42          * @return Neo4jNode implementation
  43          */
  44         public <T extends GraphNode> Either<T, Neo4jOperationStatus> create(GraphNeighbourTable graphNeighbourTable,
  45                         Class<T> clazz, NodeTypeEnum nodeType);
  46
  47         /**
  48          * return the node data by unique id.
  49          *
  50          * @param id
  51          *            - unique id of the node
  52          * @param clazz
  53          * @param nodeType
  54          * @return
  55          */
  56         public <T extends GraphNode> Either<T, Neo4jOperationStatus> getNodeData(String id, Class<T> clazz,
  57                         NodeTypeEnum nodeType);
  58
  59         public <T extends GraphNode> Either<T, Neo4jOperationStatus> getNodeData(String keyName, String id, Class<T> clazz,
  60                         NodeTypeEnum nodeType);
  61
  62         public <T extends GraphNode> Either<List<T>, Neo4jOperationStatus> getNodesData(
  63                         Map<String, Object> propertiesToMatch, Class<T> clazz, NodeTypeEnum nodeTypeEnum);
  64 }