jackrabbit-oak-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From thom...@apache.org
Subject svn commit: r1423792 - in /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak: query/ast/ spi/query/
Date Wed, 19 Dec 2012 08:48:24 GMT
Author: thomasm
Date: Wed Dec 19 08:48:22 2012
New Revision: 1423792

URL: http://svn.apache.org/viewvc?rev=1423792&view=rev
Log:
OAK-301 Document Oak internals

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/BindVariableValueImpl.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinImpl.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinType.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Operator.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Order.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Cursors.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Filter.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/PropertyStateValue.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/QueryIndexProvider.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/BindVariableValueImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/BindVariableValueImpl.java?rev=1423792&r1=1423791&r2=1423792&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/BindVariableValueImpl.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/BindVariableValueImpl.java
Wed Dec 19 08:48:22 2012
@@ -22,7 +22,6 @@ import javax.jcr.PropertyType;
 
 import org.apache.jackrabbit.oak.api.PropertyValue;
 
-
 /**
  * A bind variable.
  */

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinImpl.java?rev=1423792&r1=1423791&r2=1423792&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinImpl.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinImpl.java
Wed Dec 19 08:48:22 2012
@@ -17,7 +17,8 @@ import org.apache.jackrabbit.oak.query.Q
 import org.apache.jackrabbit.oak.spi.state.NodeState;
 
 /**
- * A join.
+ * A join. This object contains the left hand side source, the right hand side
+ * source, the join type, and the join condition.
  */
 public class JoinImpl extends SourceImpl {
 

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinType.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinType.java?rev=1423792&r1=1423791&r2=1423792&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinType.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/JoinType.java
Wed Dec 19 08:48:22 2012
@@ -17,7 +17,7 @@
 package org.apache.jackrabbit.oak.query.ast;
 
 /**
- * Enumeration of the join types.
+ * The enumeration of all join types.
  */
 public enum JoinType {
 

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Operator.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Operator.java?rev=1423792&r1=1423791&r2=1423792&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Operator.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Operator.java
Wed Dec 19 08:48:22 2012
@@ -17,7 +17,7 @@
 package org.apache.jackrabbit.oak.query.ast;
 
 /**
- * Enumeration of operators.
+ * The enumeration of all operators.
  */
 public enum Operator {
 

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Order.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Order.java?rev=1423792&r1=1423791&r2=1423792&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Order.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/Order.java
Wed Dec 19 08:48:22 2012
@@ -17,7 +17,7 @@
 package org.apache.jackrabbit.oak.query.ast;
 
 /**
- * Enumeration of query orders.
+ * The enumeration of query column orders (ascending and descending).
  */
 public enum Order {
 

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Cursors.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Cursors.java?rev=1423792&r1=1423791&r2=1423792&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Cursors.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Cursors.java
Wed Dec 19 08:48:22 2012
@@ -36,7 +36,8 @@ import static org.apache.jackrabbit.oak.
 import static org.apache.jackrabbit.oak.spi.query.Filter.PathRestriction.ALL_CHILDREN;
 
 /**
- * <code>Cursors</code> provides factory methods to create {@link Cursor}s.
+ * This utility class provides factory methods to create commonly used types of
+ * {@link Cursor}s.
  */
 public class Cursors {
 
@@ -56,9 +57,9 @@ public class Cursors {
     /**
      * Returns a traversing cursor based on the path restriction in the given
      * {@link Filter}.
-     *
-     * @param filter    the filter.
-     * @param rootState      the root {@link NodeState}.
+     * 
+     * @param filter the filter.
+     * @param rootState the root {@link NodeState}.
      * @return the {@link Cursor}.
      */
     public static Cursor newTraversingCursor(Filter filter,

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Filter.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Filter.java?rev=1423792&r1=1423791&r2=1423792&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Filter.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/Filter.java
Wed Dec 19 08:48:22 2012
@@ -27,7 +27,15 @@ import javax.jcr.PropertyType;
 import org.apache.jackrabbit.oak.api.PropertyValue;
 
 /**
- * The filter for an index lookup.
+ * The filter for an index lookup that contains a number of restrictions that
+ * are combined with AND. Possible restrictions are a property restriction, a
+ * path restriction, a node type restriction, and a fulltext restriction.
+ * <p>
+ * A property restriction could be that the property must exist, or that the
+ * property value has to be within a certain range.
+ * <p>
+ * A path restriction could be a restriction to a certain subtree, a parent of a
+ * certain path, or equality to a certain path.
  */
 public interface Filter {
 

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/PropertyStateValue.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/PropertyStateValue.java?rev=1423792&r1=1423791&r2=1423792&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/PropertyStateValue.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/PropertyStateValue.java
Wed Dec 19 08:48:22 2012
@@ -32,7 +32,6 @@ import org.apache.jackrabbit.util.ISO860
 
 /**
  * A {@link PropertyValue} implementation that wraps a {@link PropertyState}
- * 
  */
 public class PropertyStateValue implements PropertyValue {
 

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/QueryIndexProvider.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/QueryIndexProvider.java?rev=1423792&r1=1423791&r2=1423792&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/QueryIndexProvider.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/QueryIndexProvider.java
Wed Dec 19 08:48:22 2012
@@ -34,6 +34,7 @@ public interface QueryIndexProvider {
     /**
      * Get the currently configured indexes.
      * 
+     * @param nodeState the node state of the root
      * @return the list of indexes
      */
     @Nonnull



Mime
View raw message