Update the license for 2017-2018 license
[aai/aai-common.git] / aai-core / src / main / java / org / onap / aai / serialization / tinkerpop / TreeBackedEdge.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
4  * ================================================================================
5  * Copyright © 2017-2018 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 package org.onap.aai.serialization.tinkerpop;
21
22 import org.apache.tinkerpop.gremlin.structure.Direction;
23 import org.apache.tinkerpop.gremlin.structure.Edge;
24 import org.apache.tinkerpop.gremlin.structure.Graph;
25 import org.apache.tinkerpop.gremlin.structure.Vertex;
26 import org.apache.tinkerpop.gremlin.structure.util.detached.DetachedEdge;
27 import org.apache.tinkerpop.gremlin.util.iterator.IteratorUtils;
28
29 import java.util.Iterator;
30
31
32 /**
33  * Represents a {@link Edge} that is disconnected from a {@link Graph} however, 
34  * traversals are supported as they are backed by a Tree with saturated {@link Vertex} and {@link Edge} objects.
35  * These objects are not mutable and can only be used to read information out.
36  *
37  */
38 public class TreeBackedEdge extends DetachedEdge implements Edge {
39
40         private static final long serialVersionUID = 5419650145562077538L;
41         private TreeBackedVertex inVertex;
42         private TreeBackedVertex outVertex;
43         public TreeBackedEdge(Edge edge, TreeBackedVertex inVertex, TreeBackedVertex outVertex) {
44                 super(edge, true);
45                 this.inVertex = inVertex;
46                 this.outVertex = outVertex;
47         }
48         
49         @Override
50         public Vertex inVertex() {
51                 return this.inVertex;
52         }
53         
54         @Override
55         public Vertex outVertex() {
56                 return this.outVertex;
57         }
58         
59         @Override
60         public Iterator<Vertex> bothVertices() {
61                 return this.vertices(Direction.BOTH);
62         }
63         
64         @Override
65         public Iterator<Vertex> vertices(Direction direction) {
66                  switch (direction) {
67          case OUT:
68              return IteratorUtils.of(this.outVertex);
69          case IN:
70              return IteratorUtils.of(this.inVertex);
71          default:
72              return IteratorUtils.of(this.outVertex, this.inVertex);
73      }
74         }
75
76
77         
78
79 }