Renaming openecomp to onap
[aai/champ.git] / src / main / java / org / onap / aai / champ / ChampGraph.java
  * ============LICENSE_END============================================
  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  */
-package org.openecomp.aai.champ;
+package org.onap.aai.champ;
 
 import java.util.Map;
 import java.util.Optional;
 import java.util.stream.Stream;
 
-import org.openecomp.aai.champ.exceptions.ChampIndexNotExistsException;
-import org.openecomp.aai.champ.exceptions.ChampMarshallingException;
-import org.openecomp.aai.champ.exceptions.ChampObjectNotExistsException;
-import org.openecomp.aai.champ.exceptions.ChampRelationshipNotExistsException;
-import org.openecomp.aai.champ.exceptions.ChampSchemaViolationException;
-import org.openecomp.aai.champ.exceptions.ChampUnmarshallingException;
-import org.openecomp.aai.champ.graph.impl.InMemoryChampGraphImpl;
-import org.openecomp.aai.champ.graph.impl.TitanChampGraphImpl;
-import org.openecomp.aai.champ.model.ChampObject;
-import org.openecomp.aai.champ.model.ChampObjectConstraint;
-import org.openecomp.aai.champ.model.ChampObjectIndex;
-import org.openecomp.aai.champ.model.ChampPartition;
-import org.openecomp.aai.champ.model.ChampRelationship;
-import org.openecomp.aai.champ.model.ChampRelationshipConstraint;
-import org.openecomp.aai.champ.model.ChampRelationshipIndex;
-import org.openecomp.aai.champ.model.ChampSchema;
+import org.onap.aai.champ.exceptions.ChampIndexNotExistsException;
+import org.onap.aai.champ.exceptions.ChampMarshallingException;
+import org.onap.aai.champ.exceptions.ChampObjectNotExistsException;
+import org.onap.aai.champ.exceptions.ChampRelationshipNotExistsException;
+import org.onap.aai.champ.exceptions.ChampSchemaViolationException;
+import org.onap.aai.champ.exceptions.ChampUnmarshallingException;
+import org.onap.aai.champ.graph.impl.InMemoryChampGraphImpl;
+import org.onap.aai.champ.graph.impl.TitanChampGraphImpl;
+import org.onap.aai.champ.model.ChampObject;
+import org.onap.aai.champ.model.ChampObjectConstraint;
+import org.onap.aai.champ.model.ChampObjectIndex;
+import org.onap.aai.champ.model.ChampPartition;
+import org.onap.aai.champ.model.ChampRelationship;
+import org.onap.aai.champ.model.ChampRelationshipConstraint;
+import org.onap.aai.champ.model.ChampRelationshipIndex;
+import org.onap.aai.champ.model.ChampSchema;
 
 public interface ChampGraph {
 
@@ -86,7 +86,7 @@ public interface ChampGraph {
         * @return The ChampObject as it was stored
         * @throws ChampMarshallingException If the {@code object} is not able to be marshalled into the backend representation
         * @throws ChampSchemaViolationException If the {@code object} violates the constraints specifed by {@link ChampGraph#retrieveSchema}
-        * @throws ChampObjectNotExistsException If {@link org.openecomp.aai.champ.model.ChampObject#getKey}.isPresent() but the object cannot be found in the graph 
+        * @throws ChampObjectNotExistsException If {@link org.onap.aai.champ.model.ChampObject#getKey}.isPresent() but the object cannot be found in the graph 
         */
        public ChampObject storeObject(ChampObject object) throws ChampMarshallingException, ChampSchemaViolationException, ChampObjectNotExistsException;
        
@@ -98,14 +98,14 @@ public interface ChampGraph {
         * @return The ChampObject as it was stored
         * @throws ChampMarshallingException If the {@code object} is not able to be marshalled into the backend representation
         * @throws ChampSchemaViolationException If the {@code object} violates the constraints specifed by {@link ChampGraph#retrieveSchema}
-        * @throws ChampObjectNotExistsException If {@link org.openecomp.aai.champ.model.ChampObject#getKey} is not present or object not found in the graph
+        * @throws ChampObjectNotExistsException If {@link org.onap.aai.champ.model.ChampObject#getKey} is not present or object not found in the graph
         */
        public ChampObject replaceObject(ChampObject object) throws ChampMarshallingException, ChampSchemaViolationException, ChampObjectNotExistsException;
 
        /**
         * Retrieve an object by its key.
-        * @param key The key of the ChampObject in the graph {@link org.openecomp.aai.champ.model.ChampObject#getKey()}
-        * @return The {@link org.openecomp.aai.champ.model.ChampObject} if it was present, otherwise {@link Optional#empty()}
+        * @param key The key of the ChampObject in the graph {@link org.onap.aai.champ.model.ChampObject#getKey()}
+        * @return The {@link org.onap.aai.champ.model.ChampObject} if it was present, otherwise {@link Optional#empty()}
         * @throws ChampUnmarshallingException If the object was found, but could not be unmarshalled
         */
        public Optional<ChampObject> retrieveObject(Object key) throws ChampUnmarshallingException;
@@ -133,7 +133,7 @@ public interface ChampGraph {
         * @throws ChampMarshallingException If the {@code relationship} is not able to be marshalled into the backend representation
         * @throws ChampSchemaViolationException If the {@code relationship} violates the constraints specifed by {@link ChampGraph#retrieveSchema}
         * @throws ChampObjectNotExistsException If either the source or target object referenced by this relationship does not exist in the graph
-        * @throws ChampRelationshipNotExistsException If {@link org.openecomp.aai.champ.model.ChampRelationship#getKey}.isPresent() but the object cannot be found in the graph 
+        * @throws ChampRelationshipNotExistsException If {@link org.onap.aai.champ.model.ChampRelationship#getKey}.isPresent() but the object cannot be found in the graph 
         * @throws ChampUnmarshallingException If the edge which was created could not be unmarshalled into a ChampRelationship
         */
        public ChampRelationship storeRelationship(ChampRelationship relationship) throws ChampMarshallingException, ChampObjectNotExistsException, ChampSchemaViolationException, ChampRelationshipNotExistsException, ChampUnmarshallingException;
@@ -146,7 +146,7 @@ public interface ChampGraph {
         * @return The ChampRelationship as it was stored
         * @throws ChampMarshallingException If the {@code relationship} is not able to be marshalled into the backend representation
         * @throws ChampSchemaViolationException If the {@code relationship} violates the constraints specifed by {@link ChampGraph#retrieveSchema}
-        * @throws ChampRelationshipNotExistsException If {@link org.openecomp.aai.champ.model.ChampRelationship#getKey} is not present or object not found in the graph 
+        * @throws ChampRelationshipNotExistsException If {@link org.onap.aai.champ.model.ChampRelationship#getKey} is not present or object not found in the graph 
         * @throws ChampUnmarshallingException If the edge which was created could not be unmarshalled into a ChampRelationship
         */
        public ChampRelationship replaceRelationship(ChampRelationship relationship) throws ChampMarshallingException, ChampSchemaViolationException, ChampRelationshipNotExistsException, ChampUnmarshallingException; 
@@ -154,8 +154,8 @@ public interface ChampGraph {
        
        /**
         * Retrieve a relationship by its key.
-        * @param key The key of the ChampRelationship in the graph {@link org.openecomp.aai.champ.model.ChampRelationship#getKey()}
-        * @return The {@link org.openecomp.aai.champ.model.ChampRelationship} if it was present, otherwise {@link Optional#empty()}
+        * @param key The key of the ChampRelationship in the graph {@link org.onap.aai.champ.model.ChampRelationship#getKey()}
+        * @return The {@link org.onap.aai.champ.model.ChampRelationship} if it was present, otherwise {@link Optional#empty()}
         * @throws ChampUnmarshallingException If the relationship was found, but could not be unmarshalled
         */
        public Optional<ChampRelationship> retrieveRelationship(Object key) throws ChampUnmarshallingException;