more JavaDoc on property graph interfaces. Added 0.3 released depende…

…ndies.
tinkerpop · Dec 13, 2010 · 1944c0c · 1944c0c
1 parent 0fa7d0f
commit 1944c0c
Show file tree

Hide file tree

Showing 12 changed files with 366 additions and 4 deletions.
diff --git a/graphdb-deps/graphdb-deps-orientdb-0.1-SNAPSHOT.pom b/graphdb-deps/graphdb-deps-orientdb-0.1-SNAPSHOT.pom
@@ -22,12 +22,12 @@
         <dependency>
             <groupId>com.orientechnologies</groupId>
             <artifactId>orientdb-core</artifactId>
-            <version>0.9.24</version>
+            <version>0.9.25-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.orientechnologies</groupId>
             <artifactId>orient-commons</artifactId>
-            <version>0.9.24</version>
+            <version>0.9.25-SNAPSHOT</version>
         </dependency>
     </dependencies>
     <repositories>

diff --git a/src/main/java/com/tinkerpop/blueprints/pgm/AutomaticIndex.java b/src/main/java/com/tinkerpop/blueprints/pgm/AutomaticIndex.java
@@ -4,6 +4,7 @@
 
 /**
  * An automatic index will automatically maintain an index of element properties as the element properties mutate.
+ * The key/value pairs that are automatically monitored are element properties and their values.
  *
  * @author Marko A. Rodriguez (http://markorodriguez.com)
  */

diff --git a/src/main/java/com/tinkerpop/blueprints/pgm/Graph.java b/src/main/java/com/tinkerpop/blueprints/pgm/Graph.java
@@ -2,7 +2,6 @@
 
 /**
  * A graph is a container object for a collection of vertices and a collection edges.
- * A graph can maintain an index which can be used to index vertices and edges by their key/value properties.
  *
  * @author Marko A. Rodriguez (http://markorodriguez.com)
  */

diff --git a/src/main/java/com/tinkerpop/blueprints/pgm/Index.java b/src/main/java/com/tinkerpop/blueprints/pgm/Index.java
@@ -2,6 +2,8 @@
 
 /**
  * An index maintains a mapping between some key/value pair and an element.
+ * A manual index requires that the developers code explicitly put elements of the graph into the index.
+ * A the key/value pair need not be specific to the element properties.
  *
  * @author Marko A. Rodriguez (http://markorodriguez.com)
  */

diff --git a/src/main/java/com/tinkerpop/blueprints/pgm/IndexableGraph.java b/src/main/java/com/tinkerpop/blueprints/pgm/IndexableGraph.java
@@ -3,6 +3,7 @@
 /**
  * An indexable graph is a graph that supports the indexing of its elements.
  * An index is typically some sort of tree structure that allows for the fast lookup of elements by key/value pairs.
+ * All indexable graphs are initially constructed with two automatic indices called "vertices" and "edges."
  *
  * @author Marko A. Rodriguez (http://markorodriguez.com)
  */

diff --git a/src/main/java/com/tinkerpop/blueprints/pgm/TransactionalGraph.java b/src/main/java/com/tinkerpop/blueprints/pgm/TransactionalGraph.java
@@ -4,11 +4,15 @@
  * A transactional graph supports the notion of transactions.
  * Once a transaction is started, all write operations can either be committed or rolled back.
  * Read operations are not required to be in a transaction.
+ * A transactional graph can be in two modes: automatic or manual.
  *
  * @author Marko A. Rodriguez (http://markorodriguez.com)
  */
 public interface TransactionalGraph extends Graph {
 
+    /**
+     * Error message to use when code is trying to stop/stop a transaction in automatic transaction mode.
+     */
     public static final String TURN_OFF_MESSAGE = "Turn off automatic transactions to use manual transaction handling";
 
     /**
@@ -34,7 +38,8 @@ public enum Mode {
     public void startTransaction();
 
     /**
-     * Stop the current transaction. Specify whether the transaction was successful or not.
+     * Stop the current transaction. This is possible only in manual transaction mode.
+     * Specify whether the transaction was successful or not.
      * A failing transaction will rollback all updates to before the transaction was started.
      *
      * @param conclusion whether or not the current transaction was successful or not

diff --git a/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-all-0.3.pom b/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-all-0.3.pom
@@ -0,0 +1,69 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.tinkerpop</groupId>
+    <artifactId>graphdb-deps-all</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <packaging>pom</packaging>
+    <name>GraphDB Dependencies-All</name>
+    <url>http://tinkerpop.com</url>
+    <developers>
+        <developer>
+            <name>Marko A. Rodriguez</name>
+            <email>marko@markorodriguez.com</email>
+            <url>http://markorodriguez.com</url>
+        </developer>
+    </developers>
+    <inceptionYear>2010</inceptionYear>
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+    <dependencies>
+        <!-- NEO4J SUPPORT -->
+        <dependency>
+            <groupId>com.tinkerpop</groupId>
+            <artifactId>graphdb-deps-neo4j</artifactId>
+            <version>0.3</version>
+            <type>pom</type>
+        </dependency>
+        <!-- ORIENTDB SUPPORT -->
+        <dependency>
+            <groupId>com.tinkerpop</groupId>
+            <artifactId>graphdb-deps-orientdb</artifactId>
+            <version>0.3</version>
+            <type>pom</type>
+        </dependency>
+        <!-- SAIL SUPPORT -->
+        <dependency>
+            <groupId>com.tinkerpop</groupId>
+            <artifactId>graphdb-deps-sail</artifactId>
+            <version>0.3</version>
+            <type>pom</type>
+        </dependency>
+        <!-- NEO4J SAIL SUPPORT -->
+        <dependency>
+            <groupId>com.tinkerpop</groupId>
+            <artifactId>graphdb-deps-neo4jsail</artifactId>
+            <version>0.3</version>
+            <type>pom</type>
+        </dependency>
+        <!-- LINKED DATA SAIL SUPPORT -->
+        <dependency>
+            <groupId>com.tinkerpop</groupId>
+            <artifactId>graphdb-deps-lds</artifactId>
+            <version>0.3</version>
+            <type>pom</type>
+        </dependency>
+    </dependencies>
+    <repositories>
+        <repository>
+            <id>tinkerpop-repository</id>
+            <name>TinkerPop Maven2 Repository</name>
+            <url>http://tinkerpop.com/maven2</url>
+            <snapshots>
+                <enabled>true</enabled>
+                <updatePolicy>always</updatePolicy>
+            </snapshots>
+        </repository>
+    </repositories>
+</project>
diff --git a/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-lds-0.3.pom b/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-lds-0.3.pom
@@ -0,0 +1,39 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.tinkerpop</groupId>
+    <artifactId>graphdb-deps-lds</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <packaging>pom</packaging>
+    <name>GraphDB Dependencies-LinkedDataSail</name>
+    <url>http://code.google.com/p/ripple/wiki/LinkedDataSail</url>
+    <developers>
+        <developer>
+            <name>Marko A. Rodriguez</name>
+            <email>marko@markorodriguez.com</email>
+            <url>http://markorodriguez.com</url>
+        </developer>
+    </developers>
+    <inceptionYear>2010</inceptionYear>
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>net.fortytwo</groupId>
+            <artifactId>linked-data-sail</artifactId>
+            <version>0.5</version>
+        </dependency>
+    </dependencies>
+    <repositories>
+        <repository>
+            <id>neo4j-public-repository</id>
+            <name>Publicly available Maven 2 repository for Neo4j</name>
+            <url>http://m2.neo4j.org</url>
+            <snapshots>
+                <enabled>true</enabled>
+                <updatePolicy>always</updatePolicy>
+            </snapshots>
+        </repository>
+    </repositories>
+</project>
diff --git a/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-neo4j-0.3.pom b/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-neo4j-0.3.pom
@@ -0,0 +1,40 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.tinkerpop</groupId>
+    <artifactId>graphdb-deps-neo4j</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <packaging>pom</packaging>
+    <name>GraphDB Dependencies-Neo4j</name>
+    <url>http://neo4j.org</url>
+    <developers>
+        <developer>
+            <name>Marko A. Rodriguez</name>
+            <email>marko@markorodriguez.com</email>
+            <url>http://markorodriguez.com</url>
+        </developer>
+    </developers>
+    <inceptionYear>2010</inceptionYear>
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>org.neo4j</groupId>
+            <artifactId>neo4j</artifactId>
+            <version>1.2.M05</version>
+            <type>pom</type>
+        </dependency>
+    </dependencies>
+    <repositories>
+        <repository>
+            <id>neo4j-public-repository</id>
+            <name>Publicly available Maven 2 repository for Neo4j</name>
+            <url>http://m2.neo4j.org</url>
+            <snapshots>
+                <enabled>true</enabled>
+                <updatePolicy>always</updatePolicy>
+            </snapshots>
+        </repository>
+    </repositories>
+</project>
diff --git a/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-neo4jsail-0.3.pom b/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-neo4jsail-0.3.pom
@@ -0,0 +1,45 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.tinkerpop</groupId>
+    <artifactId>graphdb-deps-neo4jsail</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <packaging>pom</packaging>
+    <name>GraphDB Dependencies-Neo4jSail</name>
+    <url>http://components.neo4j.org/neo4j-rdf-sail/</url>
+    <developers>
+        <developer>
+            <name>Marko A. Rodriguez</name>
+            <email>marko@markorodriguez.com</email>
+            <url>http://markorodriguez.com</url>
+        </developer>
+    </developers>
+    <inceptionYear>2010</inceptionYear>
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>org.neo4j</groupId>
+            <artifactId>neo4j-rdf-sail</artifactId>
+            <version>0.6-SNAPSHOT</version>
+        </dependency>
+        <dependency>
+            <groupId>org.neo4j</groupId>
+            <artifactId>neo4j-rdf</artifactId>
+            <version>0.7-SNAPSHOT</version>
+            <type>jar</type>
+        </dependency>
+    </dependencies>
+    <repositories>
+        <repository>
+            <id>neo4j-public-repository</id>
+            <name>Publicly available Maven 2 repository for Neo4j</name>
+            <url>http://m2.neo4j.org</url>
+            <snapshots>
+                <enabled>true</enabled>
+                <updatePolicy>always</updatePolicy>
+            </snapshots>
+        </repository>
+    </repositories>
+</project>
diff --git a/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-orientdb-0.3.pom b/src/main/resources/com/tinkerpop/blueprints/deps/graphdb-deps-orientdb-0.3.pom
@@ -0,0 +1,44 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.tinkerpop</groupId>
+    <artifactId>graphdb-deps-orientdb</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <packaging>pom</packaging>
+    <name>GraphDB Dependencies-OrientDB</name>
+    <url>http://orientechnologies.com/</url>
+    <developers>
+        <developer>
+            <name>Marko A. Rodriguez</name>
+            <email>marko@markorodriguez.com</email>
+            <url>http://markorodriguez.com</url>
+        </developer>
+    </developers>
+    <inceptionYear>2010</inceptionYear>
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>com.orientechnologies</groupId>
+            <artifactId>orientdb-core</artifactId>
+            <version>0.9.25-SNAPSHOT</version>
+        </dependency>
+        <dependency>
+            <groupId>com.orientechnologies</groupId>
+            <artifactId>orient-commons</artifactId>
+            <version>0.9.25-SNAPSHOT</version>
+        </dependency>
+    </dependencies>
+    <repositories>
+        <repository>
+            <id>orientechnologies-repository</id>
+            <name>Orient Technologies Maven2 Repository</name>
+            <url>http://www.orientechnologies.com/listing/m2</url>
+            <snapshots>
+                <enabled>true</enabled>
+                <updatePolicy>always</updatePolicy>
+            </snapshots>
+        </repository>
+    </repositories>
+</project>