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