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
|
/**
* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
* Copyright © 2019 AT&T Intellectual Property. All rights reserved.
* Copyright © 2019 Amdocs
* ================================================================================
* 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=========================================================
*/
package org.onap.aai.schemaif;
import java.util.Map;
import java.util.Set;
import org.onap.aai.schemaif.definitions.EdgeSchema;
import org.onap.aai.schemaif.definitions.VertexSchema;
public interface SchemaProvider {
/**
* Load the schema into memory
*/
void loadSchema() throws SchemaProviderException;
/**
* Get the identifier for the more recent version of the schema
*
* @return The schema version identifier
*/
String getLatestSchemaVersion() throws SchemaProviderException;
/**
* Get the schema definition for a vertex
*
* @param vertexName - Name of the vertex
* @param schemaVersion - Version of the schema to use
*
* @return The vertex schema definition
*/
VertexSchema getVertexSchema(String vertexName, String schemaVersion) throws SchemaProviderException;
/**
* Get the schema definition for an edge
*
* @param edgeType - Type of the edge
* @param sourceVertex - The source vertex for the edge
* @param targetVertex - The target vertex for the edge
* @param version - Version of the schema to use
*
* @return The edge schema definition
*/
EdgeSchema getEdgeSchema(String edgeType, String sourceVertex, String targetVertex, String version)
throws SchemaProviderException;
/**
* Get the list of edge definitions which are adjacent to the given vertex
*
* @param vertexType - Type of the vertex
* @param version - Version of the schema to use
*
* @return The list of edge schema definitions
*/
Set<EdgeSchema> getAdjacentEdgeSchema(String vertexType, String version) throws SchemaProviderException;
/**
* Get the list of edge definitions which are valid for the given source and target
*
* @param sourceType - Type of the source vertex
* @param targetType - Type of the target vertex
* @param version - Version of the schema to use
*
* @return The list of edge schema definitions
*/
Set<EdgeSchema> getEdgeSchemaForSourceTarget(String sourceType, String targetType, String version)
throws SchemaProviderException;
/**
* Get vertex map for a schema version
*
* @param schemaVersion - Version of the schema to use
*
* @return The list of vertex types
*/
Map<String, VertexSchema> getVertexMap(String schemaVersion) throws SchemaProviderException;
}
|
