1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/**
* ============LICENSE_START=======================================================
* Gizmo
* ================================================================================
* Copyright © 2017 AT&T Intellectual Property.
* Copyright © 2017 Amdocs
* All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
*/
package org.openecomp.crud.dao;
import org.openecomp.crud.entity.Edge;
import org.openecomp.crud.entity.Vertex;
import org.openecomp.crud.exception.CrudException;
import java.util.List;
import java.util.Map;
public interface GraphDao {
public Vertex getVertex(String id, String type) throws CrudException;
/**
* Retrieve all of the edges which are incident to the vertex with the specified identifier.
*
* @param id - The unique identifier of the vertex to retrieve the edges for.
* @return - A collection of edges.
* @throws CrudException
*/
public List<Edge> getVertexEdges(String id) throws CrudException;
/**
* Retrieve a collection of {@link Vertex} objects which match the supplied type label
* and filter properties.
*
* @param type - The vertex type that we want to retrieve.
* @param filter - The parameters to filter our results by.
* @return - A collection of vertices.
* @throws CrudException
*/
public List<Vertex> getVertices(String type, Map<String, Object> filter) throws CrudException;
/**
* Retrieve an {@link Edge} from the graph database by specifying its unique identifier.
*
* @param id - The unique identifier for the Edge to be retrieved.
* @return - The Edge corresponding to the specified identifier.
* @throws CrudException
*/
public Edge getEdge(String id, String type) throws CrudException;
/**
* Retrieve a collection of {@link Edge} objects with a given type and which match a set of
* supplied filter parameters.
*
* @param type - The type of edges that we are interested in.
* @param filter - The parameters that we want to filter our edges by.
* @return - A collection of edges which match the supplied filter parameters.
* @throws CrudException
*/
public List<Edge> getEdges(String type, Map<String, Object> filter) throws CrudException;
/**
* Insert a new {@link Vertex} into the graph data store.
*
* @param type - The type label to assign to the vertex.
* @param properties - The properties to associated with this vertex.
* @return - The {@link Vertex} object that was created.
* @throws CrudException
*/
public Vertex addVertex(String type, Map<String, Object> properties) throws CrudException;
/**
* Updates an existing {@link Vertex}.
*
* @param id - The unique identifier of the vertex to be updated.
* @param properties - The properties to associate with the vertex.
* @return - The udpated vertex.
* @throws CrudException
*/
public Vertex updateVertex(String id, String type, Map<String, Object> properties)
throws CrudException;
/**
* Removes the specified vertex from the graph data base.
*
* <p>NOTE: The vertex MUST contain NO incident edges before it can be deleted.
*
* @param id - The unique identifier of the vertex to be deleted.
* @throws CrudException
*/
public void deleteVertex(String id, String type) throws CrudException;
/**
* Adds an edge to the graph database.
*
* @param type - The 'type' label to apply to the edge.
* @param source - The source vertex for this edge.
* @param target - The target vertex for this edge.
* @param properties - The properties map to associate with this edge.
* @return - The {@link Edge} object that was created.
* @throws CrudException
*/
public Edge addEdge(String type, Vertex source, Vertex target, Map<String, Object> properties)
throws CrudException;
/**
* Updates an existing {@link Edge}.
*
* @param id - The unique identifier of the edge to be updated.
* @param properties - The properties to associate with the edge.
* @return - The update edge.
* @throws CrudException
*/
public Edge updateEdge(Edge edge) throws CrudException;
/**
* Remove the specified edge from the graph data base.
*
* @param id - The unique identifier of the edge to be deleted.
* @throws CrudException
*/
public void deleteEdge(String id, String type) throws CrudException;
}
|
