Changeset 4600

Timestamp:

Oct 24, 2008, 1:43:13 PM (14 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #1156: Add support for ALL and ANY constructs to the Query API

Location:

trunk/src/core/net/sf/basedb/core

Files:

• AbstractEntityQuery.java (modified) (5 diffs)
• AbstractQuery.java (modified) (11 diffs)
• AbstractSqlQuery.java (modified) (2 diffs)
• query/Expressions.java (modified) (1 diff)
• query/HqlPropertyExpression.java (modified) (1 diff)
• query/Query.java (modified) (3 diffs)
• query/QueryParameter.java (added)
• query/SubqueryExpression.java (added)

trunk/src/core/net/sf/basedb/core/AbstractEntityQuery.java

@@ -26 +26 @@
 import net.sf.basedb.core.query.EntityQuery;
 import net.sf.basedb.core.query.JoinType;
+import net.sf.basedb.core.query.QueryParameter;
 import net.sf.basedb.core.query.Select;
 import net.sf.basedb.core.query.Expression;
@@ -414 +415 @@
     lastMainDc = dc;
     lastMainQuery.setCacheable(isCachingResult());
-    setParameters(lastMainQuery, getPermanentParameters());
     setParameters(lastMainQuery, getParameters());
     if (getFirstResult() >= 0) lastMainQuery.setFirstResult(getFirstResult());
@@ -447 +447 @@
     lastCountDc = dc;
     lastCountQuery.setCacheable(true);
-    setParameters(lastCountQuery, getPermanentParameters());
     setParameters(lastCountQuery, getParameters());
     return lastCountQuery;
@@ -497 +496 @@
     @param parameters A map containing parameter names and values
   */
-  private void setParameters(org.hibernate.Query query, Map<String, Object> parameters)
+  private void setParameters(org.hibernate.Query query, Map<String, QueryParameter> parameters)
   {
     if (parameters == null) return;
@@ -504 +503 @@
       logParam.debug("Binding parameters to query: " + query.getQueryString());
     }
-    for (Map.Entry<String, Object> entry : parameters.entrySet())
+    for (Map.Entry<String, QueryParameter> entry : parameters.entrySet())
     {
       String name = entry.getKey();
-      Object value = entry.getValue();
-      Type valueType = getParameterType(name);
+      QueryParameter qp = entry.getValue();
+      Type valueType = qp.getType();
+      Object value = qp.getValue();
       if (value instanceof Collection)
       {

trunk/src/core/net/sf/basedb/core/AbstractQuery.java

@@ -27 +27 @@
 import net.sf.basedb.core.query.Query;
 import net.sf.basedb.core.query.QueryElement;
+import net.sf.basedb.core.query.QueryParameter;
 import net.sf.basedb.core.query.QuerySection;
 import net.sf.basedb.core.query.Select;
@@ -35 +36 @@
 import net.sf.basedb.util.NestedIterator;
 
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.Iterator;
@@ -152 +154 @@
     Parameters values added to the query.
   */
-  private Map<String, Object> parameters;
-
-  /**
-    Permanent parameter values added to the query.
-  */
-  private Map<String, Object> permanentParameters;
-
-  /**
-    Maps parameters to types.
-  */
-  private Map<String, Type> parameterTypes;
-  
+  private Map<String, QueryParameter> parameters;
+
   /**
     The index of the first result that should be returned by the query.
@@ -354 +346 @@
   }
   
-  public void setParameter(String name, Object value, Type valueType)
-    throws InvalidDataException, BaseException
+  private void setParameter(String name, boolean permanent, Object value, Type valueType)
   {
     if (name == null) throw new InvalidUseOfNullException("name");
     if (value == null) throw new InvalidUseOfNullException("value");
-    if (permanentParameters != null && permanentParameters.containsKey(name))
-    {
-      throw new InvalidDataException("The parameter "+name+" has already been permanently set and cannot be changed");
-    }
-    if (valueType != null)
-    {
-      if (value != null) validateParameterType(name, value, valueType);
-      if (parameterTypes == null) parameterTypes = new HashMap<String, Type>();
-      parameterTypes.put(name, valueType);
-    }
-    if (parameters == null) parameters = new HashMap<String, Object>();
-    parameters.put(name, value);
-  }
+    if (parameters == null) parameters = new HashMap<String, QueryParameter>();
+    QueryParameter qp = parameters.get(name);
+    if (qp != null && qp.isPermanent())
+    {
+      throw new InvalidDataException("The parameter '"+name+
+          "' has already been permanently set and cannot be changed");
+    }
+    if (valueType != null && value != null) validateParameterType(name, value, valueType);
+    parameters.put(name, new QueryParameter(name, permanent, valueType, value));
+  }
+  
+  public void setParameter(String name, Object value, Type valueType)
+    throws InvalidDataException, BaseException
+  {
+    setParameter(name, false, value, valueType);
+  }
+  
   public void setPermanentParameter(String name, Object value, Type valueType)
     throws InvalidDataException, BaseException
   {
-    if (name == null) throw new InvalidUseOfNullException("name");
-    if (value == null) throw new InvalidUseOfNullException("value");
-    if (permanentParameters == null) permanentParameters = new HashMap<String, Object>();
-    if (valueType != null)
-    {
-      if (value != null) validateParameterType(name, value, valueType);
-      if (parameterTypes == null) parameterTypes = new HashMap<String, Type>();
-      parameterTypes.put(name, valueType);
-    }
-    if (permanentParameters.containsKey(name))
-    {
-      throw new InvalidDataException("The parameter "+name+" has already been permanently set and cannot be changed");
-    }
-    permanentParameters.put(name, value);
+    setParameter(name, true, value, valueType);
   }
 
   public boolean hasParameterValue(String name)
   {
-    return (parameters != null && parameters.containsKey(name)) || 
-      (permanentParameters != null && permanentParameters.containsKey(name));
+    return (parameters != null && parameters.containsKey(name));
+  }
+  
+  /**
+    @since 2.9
+  */
+  @Override
+  public Set<String> getParameterNames()
+  {
+    if (parameters == null)
+    {
+      return Collections.emptySet();
+    }
+    else
+    {
+      return parameters.keySet();
+    }
+  }
+  
+  /**
+    @since 2.9
+  */
+  @Override
+  public QueryParameter getQueryParameter(String name)
+  {
+    return parameters == null ? null : parameters.get(name);
   }
   
@@ -468 +474 @@
     return querySection;
   }
+  
+  @Override
+  public String toQl(DbControl dc)
+  {
+    return getMainQuery(dc, true);
+  }
   // -------------------------------------------
 
@@ -530 +542 @@
   
   /**
-    Get all permanent parameter values.
-  */
-  Map<String, Object> getPermanentParameters()
-  {
-    return permanentParameters;
-  }
-  
-  /**
-    Get all non-permanent parameter values.
-  */
-  Map<String, Object> getParameters()
+    Get all query parameters.
+  */
+  Map<String, QueryParameter> getParameters()
   {
     return parameters;
-  }
-  
-  /**
-    Get the types of all parameters.
-  */
-  Map<String, Type> getParameterTypes()
-  {
-    return parameterTypes;
   }
   
@@ -561 +557 @@
   Object getParameterValue(String name)
   {
-    if (permanentParameters != null && permanentParameters.containsKey(name))
-    {
-      return permanentParameters.get(name);
-    }
-    else if (parameters != null)
-    {
-      return parameters.get(name);
-    }
-    return null;
+    QueryParameter qp = getQueryParameter(name);
+    return qp == null ? null : qp.getValue();
   }
 
@@ -577 +566 @@
   Type getParameterType(String name)
   {
-    return parameterTypes == null ? null : parameterTypes.get(name);
+    QueryParameter qp = getQueryParameter(name);
+    return qp == null ? null : qp.getType();
   }
   
@@ -595 +585 @@
     // Append SELECT elements
     appended = appendSelects(ql, dc, temporarySelects, 0);
-    appended += appendSelects(ql,dc, permanentSelects, appended);
-    appended += appendSelects(ql,dc, selects, appended);
+    appended += appendSelects(ql, dc, permanentSelects, appended);
+    appended += appendSelects(ql, dc, selects, appended);
     
     querySection = QuerySection.FROM;
@@ -657 +647 @@
       // Append SELECT elements
       appended = appendSelects(ql, dc, temporarySelects, 0);
-      appended += appendSelects(ql,dc, permanentSelects, appended);
-      appended += appendSelects(ql,dc, selects, appended);
+      appended += appendSelects(ql, dc, permanentSelects, appended);
+      appended += appendSelects(ql, dc, selects, appended);
       ql.append(") ");
     }
@@ -725 +715 @@
   }
 
-  private int appendJoins(StringBuilder ql, DbControl dc, List<Join> joins, boolean useThetaJoin, int alreadyAppended)
+  private int appendJoins(StringBuilder ql, DbControl dc, 
+    List<Join> joins, boolean useThetaJoin, int alreadyAppended)
     throws BaseException
   {

trunk/src/core/net/sf/basedb/core/AbstractSqlQuery.java

@@ -25 +25 @@
 
 import net.sf.basedb.core.hibernate.ResultSetWork;
+import net.sf.basedb.core.query.QueryParameter;
 import net.sf.basedb.core.query.SqlQuery;
 import net.sf.basedb.core.query.QueryType;
@@ -311 +312 @@
     for (String name : parameterOrder)
     {
-      Object parameterValue = getParameterValue(name);
-      Type valueType = getParameterType(name);
+      QueryParameter qp = getQueryParameter(name);
+      Object parameterValue = qp == null ? null : qp.getValue();
+      Type valueType = qp == null ? null : qp.getType();
       if (parameterValue instanceof Collection)
       {

trunk/src/core/net/sf/basedb/core/query/Expressions.java

@@ -360 +360 @@
   
   /**
+    Create a subquery expression: <code>ANY (subquery)</code>.
+    The expression is useful in the WHERE part of a query only.
+    For example, to find all users that are members of a group
+    having a name starting with A.
+    <pre class="code">
+Query groupFilter = User.getQuery();
+groupFilter.join(Hql.innerJoin("groups", "grp"));
+groupFilter.restrict(Restrictions.like(Hql.property("grp", "name"), Expressions.string("A%")));
+Query userQuery = User.getQuery();
+userQuery.restrict(Restrictions.eq(Hql.property("id"), Expressions.any(groupFilter)));
+</pre>
+    
+    @param subquery The subquery
+    @return The new expression
+    @throws InvalidDataException If the subquery is null
+    @since 2.9
+  */
+  public static Expression any(Query subquery)
+  {
+    if (subquery == null) throw new InvalidUseOfNullException("subquery");
+    return new SubqueryExpression("ANY", subquery);
+  }
+  
+  /**
+    Create a subquery expression: <code>ANY (subquery)</code>.
+    @param subquery The subquery
+    @return The new expression
+    @throws InvalidDataException If the subquery is null
+    @see #any(Query)
+    @since 2.9
+  */
+  public static Expression all(Query subquery)
+  {
+    if (subquery == null) throw new InvalidUseOfNullException("subquery");
+    return new SubqueryExpression("ALL", subquery);
+  }
+  
+  /**
     Test if there is null in the array.
     @return The index of the first null element,

trunk/src/core/net/sf/basedb/core/query/HqlPropertyExpression.java

@@ -82 +82 @@
   public String toString()
   {
-    return (alias == null ? "" : alias + ".") + property;
+    if (alias != null && property != null)
+    {
+      return alias + "." + property;
+    }
+    return property == null ? alias : property;
   }
   // -------------------------------------------

trunk/src/core/net/sf/basedb/core/query/Query.java

@@ -22 +22 @@
 */
 package net.sf.basedb.core.query;
+
+import java.util.Set;
 
 import net.sf.basedb.core.DbControl;
@@ -226 +228 @@
 
   /**
+    Get a set with the names for all parameters in this
+    query.
+    @return A set (empty if no parameters exists)
+    @since 2.9
+  */
+  public Set<String> getParameterNames();
+  
+  /**
+    Get parameter information for the parameter with given name.
+    @param name The name of the parameter
+    @return A QueryParameter object or null if no parameter with
+      that name exists
+    @since 2.9
+  */
+  public QueryParameter getQueryParameter(String name);
+  
+  /**
     Specify that the query should start returning rows from the
     specified row number. 0 = start returning from the first row. If the
@@ -345 +364 @@
   public QuerySection getQuerySection();
   
+  /**
+    Generate the query string that is going to be sent to the
+    underlying query system (eg. HQL/Hibernate or SQL/JDBC).
+    
+    @param dc The DbControl that is going to be used for
+      executing the query
+    @return The query string
+    @since 2.9
+  */
+  public String toQl(DbControl dc);
 }