Autogenerated markdown documentation

bio4j · May 22, 2016 · 402264e · 402264e
1 parent 7e85dab
commit 402264e
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 11 deletions.
diff --git a/docs/src/main/java/com/bio4j/angulillos/TypedEdgeIndex.java.md b/docs/src/main/java/com/bio4j/angulillos/TypedEdgeIndex.java.md
@@ -19,7 +19,7 @@ public interface TypedEdgeIndex <
   interface Unique <
     E  extends      TypedEdge<?,?, E,ET, ?,?, ?,?,?>,
     ET extends TypedEdge.Type<?,?, E,ET, ?,?, ?,?,?>,
-    P extends Property<ET,X>,
+    P extends Property<ET,X> & Arity.FromAtMostOne,
     X
   > extends
     TypedEdgeIndex<E,ET, P,X>,
@@ -33,14 +33,14 @@ get a node by providing a value of the indexed property.
     default Optional<E> getEdge(X byValue) { return getElement(byValue); }
   }
 
-  interface List <
+  interface NonUnique <
     E  extends      TypedEdge<?,?, E,ET, ?,?, ?,?,?>,
     ET extends TypedEdge.Type<?,?, E,ET, ?,?, ?,?,?>,
     P extends Property<ET,X>,
     X
   > extends
     TypedEdgeIndex<E,ET, P,X>,
-    TypedElementIndex.List<E,ET, P,X>
+    TypedElementIndex.NonUnique<E,ET, P,X>
   {
 ```
 
@@ -49,8 +49,6 @@ get a list of nodes by providing a value of the indexed property.
 ```java
     default Stream<E> getEdges(X byValue) { return getElements(byValue); }
   }
-
-
 }
 
 ```

diff --git a/docs/src/main/java/com/bio4j/angulillos/TypedElementIndex.java.md b/docs/src/main/java/com/bio4j/angulillos/TypedElementIndex.java.md
@@ -55,7 +55,7 @@ This interface declares that this index is over a property that uniquely classif
     F  extends      TypedElement<F,FT, ?,?>,
     FT extends TypedElement.Type<F,FT, ?,?>,
     // property
-    P extends Property<FT,X>,
+    P extends Property<FT,X> & Arity.FromAtMostOne,
     X
   >
     extends TypedElementIndex<F,FT, P,X>
@@ -75,7 +75,7 @@ Get an element by providing a value of the indexed property
 This interface declares that this index is over a property that classifies lists of elements for exact match queries
 
 ```java
-  interface List <
+  interface NonUnique <
     // element
     F  extends      TypedElement<F,FT, ?,?>,
     FT extends TypedElement.Type<F,FT, ?,?>,

diff --git a/docs/src/main/java/com/bio4j/angulillos/TypedVertexIndex.java.md b/docs/src/main/java/com/bio4j/angulillos/TypedVertexIndex.java.md
@@ -31,7 +31,7 @@ This interface declares that this index is over a property that uniquely classif
   interface Unique <
     V  extends      TypedVertex<V,VT, ?,?,?>,
     VT extends TypedVertex.Type<V,VT, ?,?,?>,
-    P extends Property<VT,X>,
+    P extends Property<VT,X> & Arity.FromAtMostOne,
     X
   > extends
     TypedVertexIndex<V,VT, P,X>,
@@ -49,14 +49,14 @@ get a vertex by providing a value of the indexed property. The default implement
 This interface declares that this index is over a property that classifies lists of vertices for exact match queries; it adds the method `getTypedVertexs` for that.
 
 ```java
-  interface List <
+  interface NonUnique <
     V  extends      TypedVertex<V,VT, ?,?,?>,
     VT extends TypedVertex.Type<V,VT, ?,?,?>,
     P extends Property<VT,X>,
     X
   > extends
     TypedVertexIndex<V,VT, P,X>,
-    TypedElementIndex.List<V,VT, P,X>
+    TypedElementIndex.NonUnique<V,VT, P,X>
   {
 ```
 
@@ -65,7 +65,6 @@ get a list of vertices by providing a value of the property. The default
 ```java
     default Stream<V> getVertices(X byValue) { return getElements(byValue); }
   }
-
 }
 
 ```

diff --git a/docs/src/main/java/com/bio4j/angulillos/TypedVertexQuery.java.md b/docs/src/main/java/com/bio4j/angulillos/TypedVertexQuery.java.md
@@ -10,6 +10,8 @@ import java.util.function.BiPredicate;
 
 This two interfaces are the typed version of Blueprints `VertexQuery`. Given a node, we can use this for querying relationships of a given type in or out of that node.
 
+**IMPORTANT** Ignored in build. Needs update.
+
 
 ```java
 public interface VertexQueryOut <