jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r555298 - in /jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi: QItemDefinition.java QNodeDefinition.java QNodeTypeDefinition.java QPropertyDefinition.java QueryInfo.java QueryResultRow.java
Date Wed, 11 Jul 2007 15:12:28 GMT
Author: angela
Date: Wed Jul 11 08:12:27 2007
New Revision: 555298

URL: http://svn.apache.org/viewvc?view=rev&rev=555298
Log:
javadoc
consistent interfaces

Modified:
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QItemDefinition.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeDefinition.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeTypeDefinition.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QPropertyDefinition.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryInfo.java
    jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryResultRow.java

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QItemDefinition.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QItemDefinition.java?view=diff&rev=555298&r1=555297&r2=555298
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QItemDefinition.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QItemDefinition.java
Wed Jul 11 08:12:27 2007
@@ -39,42 +39,42 @@
      *
      * @return the name of the child item.
      */
-    QName getQName();
+    public QName getQName();
 
     /**
      * Gets the name of the declaring node type.
      *
      * @return the name of the declaring node type.
      */
-    QName getDeclaringNodeType();
+    public QName getDeclaringNodeType();
 
     /**
      * Determines whether the item is 'autoCreated'.
      *
      * @return the 'autoCreated' flag.
      */
-    boolean isAutoCreated();
+    public boolean isAutoCreated();
 
     /**
      * Gets the 'onParentVersion' attribute of the item.
      *
      * @return the 'onParentVersion' attribute.
      */
-    int getOnParentVersion();
+    public int getOnParentVersion();
 
     /**
      * Determines whether the item is 'protected'.
      *
      * @return the 'protected' flag.
      */
-    boolean isProtected();
+    public boolean isProtected();
 
     /**
      * Determines whether the item is 'mandatory'.
      *
      * @return the 'mandatory' flag.
      */
-    boolean isMandatory();
+    public boolean isMandatory();
 
     /**
      * Determines whether this item definition defines a residual set of
@@ -83,7 +83,7 @@
      * @return <code>true</code> if this definition defines a residual set;
      *         <code>false</code> otherwise.
      */
-    boolean definesResidual();
+    public boolean definesResidual();
 
     /**
      * Determines whether this item definition defines a node.
@@ -91,5 +91,5 @@
      * @return <code>true</code> if this is a node definition;
      *         <code>false</code> otherwise (i.e. it is a property definition).
      */
-    boolean definesNode();
+    public boolean definesNode();
 }

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeDefinition.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeDefinition.java?view=diff&rev=555298&r1=555297&r2=555298
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeDefinition.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeDefinition.java
Wed Jul 11 08:12:27 2007
@@ -39,19 +39,19 @@
      *
      * @return the name of the default primary type.
      */
-    QName getDefaultPrimaryType();
+    public QName getDefaultPrimaryType();
 
     /**
      * Returns the array of names of the required primary types.
      *
      * @return the array of names of the required primary types.
      */
-    QName[] getRequiredPrimaryTypes();
+    public QName[] getRequiredPrimaryTypes();
 
     /**
      * Reports whether this node can have same-name siblings.
      *
      * @return the 'allowsSameNameSiblings' flag.
      */
-    boolean allowsSameNameSiblings();
+    public boolean allowsSameNameSiblings();
 }

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeTypeDefinition.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeTypeDefinition.java?view=diff&rev=555298&r1=555297&r2=555298
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeTypeDefinition.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QNodeTypeDefinition.java
Wed Jul 11 08:12:27 2007
@@ -35,7 +35,7 @@
      *
      * @return the name of the node type or <code>null</code> if not set.
      */
-    QName getQName();
+    public QName getQName();
 
     /**
      * Returns an array containing the names of the supertypes. If no
@@ -47,21 +47,21 @@
      *
      * @return an array of supertype names
      */
-    QName[] getSupertypes();
+    public QName[] getSupertypes();
 
     /**
      * Returns the value of the mixin flag.
      *
      * @return true if this is a mixin node type; false otherwise.
      */
-    boolean isMixin();
+    public boolean isMixin();
 
     /**
      * Returns the value of the orderableChildNodes flag.
      *
      * @return true if nodes of this node type can have orderable child nodes; false otherwise.
      */
-    boolean hasOrderableChildNodes();
+    public boolean hasOrderableChildNodes();
 
     /**
      * Returns the name of the primary item (one of the child items of the
@@ -69,7 +69,7 @@
      *
      * @return the name of the primary item or <code>null</code> if not set.
      */
-    QName getPrimaryItemName();
+    public QName getPrimaryItemName();
 
     /**
      * Returns an array containing the property definitions or
@@ -78,7 +78,7 @@
      * @return an array containing the property definitions or
      *         <code>null</code> if not set.
      */
-    QPropertyDefinition[] getPropertyDefs();
+    public QPropertyDefinition[] getPropertyDefs();
 
     /**
      * Returns an array containing the child node definitions or
@@ -87,7 +87,7 @@
      * @return an array containing the child node definitions or
      *         <code>null</code> if not set.
      */
-    QNodeDefinition[] getChildNodeDefs();
+    public QNodeDefinition[] getChildNodeDefs();
 
     /**
      * Returns a collection of node type <code>QName</code>s that are being
@@ -101,5 +101,5 @@
      *
      * @return a collection of node type <code>QName</code>s
      */
-    Collection getDependencies();
+    public Collection getDependencies();
 }

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QPropertyDefinition.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QPropertyDefinition.java?view=diff&rev=555298&r1=555297&r2=555298
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QPropertyDefinition.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QPropertyDefinition.java
Wed Jul 11 08:12:27 2007
@@ -38,14 +38,14 @@
      *
      * @return the required type.
      */
-    int getRequiredType();
+    public int getRequiredType();
 
     /**
      * Returns the array of value constraints.
      *
      * @return the array of value constraints.
      */
-    String[] getValueConstraints();
+    public String[] getValueConstraints();
 
     /**
      * Returns the array of default values or <code>null</code> if no default
@@ -53,12 +53,12 @@
      *
      * @return the array of default values or <code>null</code>
      */
-    QValue[] getDefaultValues();
+    public QValue[] getDefaultValues();
 
     /**
      * Reports whether this property can have multiple values.
      *
      * @return the 'multiple' flag.
      */
-    boolean isMultiple();
+    public boolean isMultiple();
 }

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryInfo.java?view=diff&rev=555298&r1=555297&r2=555298
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryInfo.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryInfo.java
Wed Jul 11 08:12:27 2007
@@ -19,9 +19,18 @@
 import org.apache.jackrabbit.name.QName;
 
 import javax.jcr.RangeIterator;
+import java.util.Map;
 
 /**
- * QueryInfo...
+ * <code>QueryInfo</code> is the the return value of
+ * {@link RepositoryService#executeQuery(SessionInfo, String, String, Map)}
+ * which is used to run a query on the <code>RepositoryService</code>. It
+ * provides access to the rows of the query result as well as to the column
+ * names.
+ *
+ * @see javax.jcr.query.QueryResult#getRows()
+ * @see javax.jcr.query.QueryResult#getColumnNames()
+ * @see javax.jcr.query.QueryResult#getNodes()
  */
 public interface QueryInfo {
 

Modified: jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryResultRow.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryResultRow.java?view=diff&rev=555298&r1=555297&r2=555298
==============================================================================
--- jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryResultRow.java
(original)
+++ jackrabbit/trunk/contrib/spi/spi/src/main/java/org/apache/jackrabbit/spi/QueryResultRow.java
Wed Jul 11 08:12:27 2007
@@ -17,26 +17,30 @@
 package org.apache.jackrabbit.spi;
 
 /**
- * <code>QueryResultRow</code>...
+ * <code>QueryResultRow</code> represents the SPI equivalent of a query result
+ * row. It provides access to the id of the Node this row represents as well
+ * as to the score and to the qualified values represent in this result row.
  */
 public interface QueryResultRow {
   
     /**
      * Returns {@link NodeId} of node this result row represents.
      * 
-     * @return node id 
+     * @return node id of the <code>Node</code> this result row represents.
      */
     public NodeId getNodeId();
     
     /**
      * Returns score of this result row.
      * 
-     * @return score
+     * @return score of this result row.
      */
     public double getScore();
     
     /**
-     * @return an array of <code>QValue</code> representing the values present
+     * Returns an array of <code>QValue</code>s.
+     *
+     * @return an array of <code>QValue</code>s representing the values present
      * in this result row.
      * @see javax.jcr.query.Row#getValue(String)
      * @see javax.jcr.query.Row#getValues()



Mime
View raw message