extend CJ api, better mutation for CjDoc stuff

Author: xamde

base/src/main/java/com/graphinout/base/cj/document/CjDirection.java

@@ -1,14 +1,13 @@
 package com.graphinout.base.cj.document;
 
+import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
 
 /**
  * Direction for edge endpoints according to Connected JSON specification.
  */
 public enum CjDirection {
-    IN("in"),
-    OUT("out"),
-    UNDIR("undir");
+    IN("in"), OUT("out"), UNDIR("undir");
 
     public static final CjDirection DEFAULT = CjDirection.UNDIR;
 
@@ -18,13 +17,18 @@ public enum CjDirection {
         this.value = value;
     }
 
-    public static CjDirection of(@Nullable String value) {
+    /**
+     * @param value may be null for default (undirected)
+     * @throws IllegalArgumentException if value is invalid (null is ok)
+     */
+    public static @NonNull CjDirection of(@Nullable String value) throws IllegalArgumentException {
         for (CjDirection direction : values()) {
             if (direction.value.equals(value)) {
                 return direction;
             }
         }
-        return UNDIR; // default
+        if (value == null) return UNDIR; // default
+        throw new IllegalArgumentException("Unknown direction: " + value);
     }
 
     public boolean isDirected() {

base/src/main/java/com/graphinout/base/cj/document/ICjCoreElement.java

@@ -12,7 +12,7 @@
 /**
  * A common super-interface for {@link ICjGraph}, {@link ICjNode} and {@link ICjEdge}.
  */
-public interface ICjCoreElement extends ICjHasId, ICjHasUri, ICjElement {
+public interface ICjCoreElement extends ICjHasId, ICjHasUri, ICjHasGraphs, ICjElement {
 
     class ParentIterator implements Iterator<ICjElement> {
 
@@ -96,8 +96,8 @@ static int findPositionOfChildInParent(ICjElement parent, ICjElement child) {
     default String abbreviatedUri() {
         String uri = uri();
         String effectiveBaseUri = effectiveBaseUri();
-        if (uri.startsWith(effectiveBaseUri+"#")) {
-            return uri.substring(effectiveBaseUri.length()+1);
+        if (uri.startsWith(effectiveBaseUri + "#")) {
+            return uri.substring(effectiveBaseUri.length() + 1);
         }
         if (uri.startsWith(effectiveBaseUri)) {
             return uri.substring(effectiveBaseUri.length());
@@ -170,8 +170,7 @@ default Iterator<ICjElement> parentIterator() {
      */
     default @NonNull String unstableId() {
         String thisId = id();
-        if (thisId != null)
-            return thisId;
+        if (thisId != null) return thisId;
 
         Iterator<ICjElement> it = parentIterator();
         StringBuilder sb = new StringBuilder();

base/src/main/java/com/graphinout/base/cj/document/ICjDocument.java

@@ -25,43 +25,10 @@ default Stream<ICjElement> directChildren() {
         return Stream.concat(Stream.concat(Stream.of(data().ifNotEmpty()), Stream.of(connectedJson())).filter(Objects::nonNull), graphs());
     }
 
-    /**
-     * @return All edges in the document, from all graphs and subgraphs.
-     */
-    default Stream<ICjEdge> edgesAll() {
-        return graphsAll().flatMap(ICjGraph::edges);
-    }
-
     default @NonNull String effectiveBaseUri() {
         return nonNullOrDefault(baseUri(), CjUris.BASE_URI_FALLBACK);
     }
 
-    default @Nullable ICjEdge findEdgeById(@NonNull String edgeId) throws IllegalStateException {
-        return edgesAll().filter(e -> e.matchesId(this, edgeId)).findFirst().orElse(null);
-    }
-
-    default @Nullable ICjGraph findGraph(String id) {
-        return graphsAll().filter(g -> g.matchesId(this, id)).findFirst().orElse(null);
-    }
-
-    default @Nullable ICjNode findNodeById(@NonNull String id) throws IllegalStateException {
-        return nodesAll().filter(n -> n.matchesId(this, id)).findFirst().orElse(null);
-    }
-
-    /**
-     * @return All nodes in the document, from all graphs and subgraphs.
-     */
-    default Stream<ICjNode> nodesAll() {
-        return graphsAll().flatMap(ICjGraph::nodes);
-    }
-
-    default Stream<ICjNode> nodesAllIncludingImplied() {
-        return Stream.concat(//
-                nodesAll(), //
-                edgesAll().flatMap(ICjEdge::nodesResolved) //
-        ).distinct().sorted();
-    }
-
     /**
      * @return the single graph (or null if none).
      * @throws IllegalStateException if multiple graphs are present

base/src/main/java/com/graphinout/base/cj/document/ICjEdge.java

@@ -16,9 +16,6 @@ public interface ICjEdge extends ICjEdgeChunk, ICjHasGraphs, ICjCoreElement, Com
 
     /**
      * Compare first by chunk properties, then by graph arrays
-     *
-     * @param other
-     * @return
      */
     @Override
     default int compareTo(@NonNull ICjEdge other) {
@@ -28,6 +25,12 @@ default int compareTo(@NonNull ICjEdge other) {
                 .compare(this, other);
     }
 
+    default void copyTo(ICjEdgeMutable targetEdge) {
+        ICjEdgeChunk.super.copyTo(targetEdge);
+        graphs().forEach(sourceGraph -> targetEdge.addGraph(sourceGraph::copyTo));
+    }
+
+
     @Override
     default Stream<ICjElement> directChildren() {
         return Stream.concat(Stream.concat(Stream.of(data()), endpoints()), graphs());

base/src/main/java/com/graphinout/base/cj/document/ICjEdgeChunk.java

@@ -54,7 +54,7 @@ default void fireStartChunk(ICjWriter cjWriter, boolean sort) {
         cjWriter.edgeStart();
         // streaming order: id, label, type, endpoints, data, graphs
         cjWriter.maybe(id(), cjWriter::id);
-        fireLabelMaybe(cjWriter,sort);
+        fireLabelMaybe(cjWriter, sort);
         ofNullable(edgeType()).ifPresent(cjWriter::edgeType);
         cjWriter.list(endpoints().toList(), CjType.ArrayOfEndpoints, sort, (iCjEndpoint, cjWriter1) -> iCjEndpoint.fire(cjWriter1, sort));
         fireDataMaybe(cjWriter);

base/src/main/java/com/graphinout/base/cj/document/ICjElement.java

@@ -20,30 +20,42 @@ default Stream<ICjElement> allElements() {
         return Stream.concat(Stream.of(this), directChildren().flatMap(ICjElement::allElements));
     }
 
+    /** @throws ClassCastException if this is not a Document */
     default ICjDocumentMutable asDocument() {
         return (ICjDocumentMutable) this;
     }
 
+    /** @throws ClassCastException if this is not a Edge */
     default ICjEdgeMutable asEdge() {
         return (ICjEdgeMutable) this;
     }
 
+    /** @throws ClassCastException if this is not a Endpoint */
     default ICjEndpointMutable asEndpoint() {
         return (ICjEndpointMutable) this;
     }
 
+    /** @throws ClassCastException if this is not a Graph */
     default ICjGraphMutable asGraph() {
         return (ICjGraphMutable) this;
     }
 
+    /** @throws ClassCastException if this is not a HasGraphs */
+    default ICjHasGraphsMutable asHasGraphsMutable() {
+        return (ICjHasGraphsMutable) this;
+    }
+
+    /** @throws ClassCastException if this is not a Node */
     default ICjNodeMutable asNode() {
         return (ICjNodeMutable) this;
     }
 
+    /** @throws ClassCastException if this is not a Port */
     default ICjPortMutable asPort() {
         return (ICjPortMutable) this;
     }
 
+    /** @throws ClassCastException if this is not a HasData */
     default ICjHasDataMutable asWithData() {
         return (ICjHasDataMutable) this;
     }
@@ -64,4 +76,5 @@ default IJsonObject toJsonValue() {
         return Objects.requireNonNull(json2JsonValueWriter.resultJsonRootObject()).asObject();
     }
 
+
 }

base/src/main/java/com/graphinout/base/cj/document/ICjGraph.java

@@ -4,7 +4,6 @@
 import com.graphinout.foundation.pure.collections.jajson.JaJson;
 import com.graphinout.foundation.pure.util.Comparables;
 import org.jspecify.annotations.NonNull;
-import org.jspecify.annotations.Nullable;
 
 import java.util.Map;
 import java.util.stream.Stream;
@@ -24,6 +23,13 @@ default int compareTo(@NonNull ICjGraph other) {
                 .compare(this, other);
     }
 
+    default void copyTo(ICjGraphMutable targetGraph) {
+        ICjGraphChunk.super.copyTo(targetGraph);
+        nodes().forEach(sourceNode -> targetGraph.addNode(sourceNode::copyTo));
+        edges().forEach(sourceEdge -> targetGraph.addEdge(sourceEdge::copyTo));
+        graphs().forEach(sourceSubGraph -> targetGraph.addGraph(sourceSubGraph::copyTo));
+    }
+
     /** Edge count in this graph, excluding subgraphs */
     default long countEdgesDirect() {
         return edges().count();
@@ -69,16 +75,14 @@ default Stream<ICjGraph> graphsNestedNonRecursive() {
 
     Stream<ICjNode> nodes();
 
-    default @Nullable ICjNode findNodeById(String nodeId) {
-        // must use the effectiveUri of this graph
-        String nodeUri = CjUris.uri(effectiveBaseUri(), nodeId);
-        return document().findNodeById(nodeUri);
-    }
-
     default Map<String, Object> toJaJsonMap() {
         return JaJson.createMap() //
-                .putMaybe(CjConstants.ID, id()).putMaybe(CjConstants.LABEL, label(), ICjLabel::toJaJsonMap).putMaybe(CjConstants.GRAPH__NODES, nodes(), ICjNode::toJaJsonMap).putMaybe(CjConstants.GRAPH__EDGES, edges(), ICjEdge::toJaJsonMap).putMaybe(CjConstants.DATA, data().ifNotEmpty(), ICjData::toJaJsonValue).putMaybe(CjConstants.GRAPHS, graphs(), ICjGraph::toJaJsonMap).build();
+                .putMaybe(CjConstants.ID, id()) //
+                .putMaybe(CjConstants.LABEL, label(), ICjLabel::toJaJsonMap) //
+                .putMaybe(CjConstants.GRAPH__NODES, nodes(), ICjNode::toJaJsonMap) //
+                .putMaybe(CjConstants.GRAPH__EDGES, edges(), ICjEdge::toJaJsonMap) //
+                .putMaybe(CjConstants.DATA, data().ifNotEmpty(), ICjData::toJaJsonValue) //
+                .putMaybe(CjConstants.GRAPHS, graphs(), ICjGraph::toJaJsonMap).build();
     }
 
-
 }

base/src/main/java/com/graphinout/base/cj/document/ICjGraphChunk.java

@@ -4,6 +4,8 @@
 import com.graphinout.foundation.pure.util.Comparables;
 import org.jspecify.annotations.Nullable;
 
+import static com.graphinout.foundation.pure.functional.Nullables.ifPresentAccept;
+
 /**
  * The part of a graph which can be sent in one go. Memory requirements for all data in this chunk are expected to be
  * below 50 MB.
@@ -24,6 +26,13 @@ static int compare(ICjGraphChunk a, ICjGraphChunk b) {
      */
     @Nullable String baseUri();
 
+    default void copyTo(ICjGraphChunkMutable target) {
+        ifPresentAccept(id(), target::id);
+        ifPresentAccept(baseUri(), target::baseUri);
+        ifPresentAccept(label(), sourceLabel -> target.labelMutable(sourceLabel::copyTo));
+        data(data -> target.dataJsonValue(data.jsonValue()));
+    }
+
     default void fireStartChunk(ICjWriter cjWriter, boolean sort) {
         cjWriter.graphStart();
         cjWriter.maybe(id(), cjWriter::id);

base/src/main/java/com/graphinout/base/cj/document/ICjGraphMutable.java

@@ -31,4 +31,8 @@ default ICjNodeMutable addNode() {
         return addNode(node -> {});
     }
 
+    void removeNode(ICjNode node);
+
+    void removeEdge(ICjEdge edge);
+
 }

base/src/main/java/com/graphinout/base/cj/document/ICjHasDataMutable.java

@@ -2,8 +2,10 @@
 
 import com.graphinout.base.cj.data.CjDataProperty;
 import com.graphinout.foundation.pure.json.document.IJsonFactory;
+import com.graphinout.foundation.pure.json.document.IJsonValue;
 import com.graphinout.foundation.pure.json.document.IJsonXmlString;
 import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
 
 import java.util.function.Consumer;
 
@@ -22,6 +24,14 @@ default void addProperty(String key, String value) {
     @Override
     @NonNull ICjDataMutable data();
 
+    default void dataJsonValue(@Nullable IJsonValue jsonValue) {
+        if (jsonValue == null) {
+            dataMutable(ICjDataMutable::removeJsonValue);
+        } else {
+            dataMutable(data -> data.setJsonValue(jsonValue));
+        }
+    }
+
     /**
      * If an {@link ICjDataMutable} was created (none existed) it is auto-aded to the CJ entity, if it is not empty.
      *