#3455 - Improve query beans such that filterMany() expressions are only on ToMany relationships

[rbygrave]

Changes the query bean code generation for "Associated beans" to have separate AssocOne and AssocMany for *ToOne and *ToMany relationships.

Moves the filterMany() expressions such that they are only available on the *ToMany relationships.

[rbygrave]

Example generated query bean with AssocOne and AssocMany:

package org.example.domain.query;

import io.ebean.typequery.PBoolean;
import io.ebean.typequery.PByteArray;
import io.ebean.typequery.PEnum;
import io.ebean.typequery.PInet;
import io.ebean.typequery.PLong;
import io.ebean.typequery.PScalar;
import io.ebean.typequery.PScalarComparable;
import io.ebean.typequery.PString;
import io.ebean.typequery.PTimestamp;
import io.ebean.typequery.PUtilDate;
import org.example.domain.Customer.Status;
import org.example.domain.otherpackage.PhoneNumber;
import org.example.domain.otherpackage.ValidEmail;
import org.example.domain.query.QAddress;
import org.example.domain.query.QContact;

/**
 * Query bean for Customer.
 * <p>
 * THIS IS A GENERATED OBJECT, DO NOT MODIFY THIS CLASS.
 */
@SuppressWarnings("unused")
@io.ebean.typequery.Generated("io.ebean.querybean.generator")
@io.ebean.typequery.TypeQueryBean("v1")
public final class QCustomer extends io.ebean.typequery.QueryBean<org.example.domain.Customer,QCustomer> {

  private static final QCustomer _alias = new QCustomer(true);

  /**
   * Return the shared 'Alias' instance used to provide properties to 
   * <code>select()</code> and <code>fetch()</code> 
   */
  public static QCustomer alias() {
    return _alias;
  }

  public PLong<QCustomer> id;
  public PLong<QCustomer> version;
  public PTimestamp<QCustomer> whenCreated;
  public PTimestamp<QCustomer> whenUpdated;
  public PEnum<QCustomer,Status> status;
  public PBoolean<QCustomer> inactive;
  public PScalar<QCustomer, PhoneNumber> phoneNumber;
  public PScalarComparable<QCustomer, ValidEmail> email;
  public PString<QCustomer> name;
  public PUtilDate<QCustomer> registered;
  public PInet<QCustomer> currentInet;
  public PString<QCustomer> comments;
  public QAddress.AssocOne<QCustomer> billingAddress;
  public QAddress.AssocOne<QCustomer> shippingAddress;
  public QContact.AssocMany<QCustomer> contacts;
  public PByteArray<QCustomer> photo;


  /**
   * Return a query bean used to build a FetchGroup.
   * <p>
   * FetchGroups are immutable and threadsafe and can be used by many
   * concurrent queries. We typically stored FetchGroup as a static final field.
   * <p>
   * Example creating and using a FetchGroup.
   * <pre>{@code
   * 
   * static final FetchGroup<Customer> fetchGroup = 
   *   QCustomer.forFetchGroup()
   *     .shippingAddress.fetch()
   *     .contacts.fetch()
   *     .buildFetchGroup();
   * 
   * List<Customer> customers = new QCustomer()
   *   .select(fetchGroup)
   *   .findList();
   * 
   * }</pre>
   */
  public static QCustomer forFetchGroup() {
    return new QCustomer(io.ebean.FetchGroup.queryFor(org.example.domain.Customer.class));
  }

  /** Construct using the default Database */
  public QCustomer() {
    super(org.example.domain.Customer.class);
  }

  /** @deprecated migrate to query.usingTransaction() */
  @Deprecated(forRemoval = true)
  public QCustomer(io.ebean.Transaction transaction) {
    super(org.example.domain.Customer.class, transaction);
  }

  /** Construct with a given Database */
  public QCustomer(io.ebean.Database database) {
    super(org.example.domain.Customer.class, database);
  }


  /** Private constructor for Alias */
  private QCustomer(boolean dummy) {
    super(dummy);
  }

  /** Private constructor for FetchGroup building */
  private QCustomer(io.ebean.Query<org.example.domain.Customer> fetchGroupQuery) {
    super(fetchGroupQuery);
  }

  /** Private constructor for filterMany */
  private QCustomer(io.ebean.ExpressionList<org.example.domain.Customer> filter) {
    super(filter);
  }

  /** Return a copy of the query bean. */
  @Override
  public QCustomer copy() {
    return new QCustomer(query().copy());
  }

  /**
   * Provides static properties to use in <em> select() and fetch() </em>
   * clauses of a query. Typically referenced via static imports. 
   */
  @io.ebean.typequery.Generated("io.ebean.querybean.generator")
  public static final class Alias {
    public static PLong<QCustomer> id = _alias.id;
    public static PLong<QCustomer> version = _alias.version;
    public static PTimestamp<QCustomer> whenCreated = _alias.whenCreated;
    public static PTimestamp<QCustomer> whenUpdated = _alias.whenUpdated;
    public static PEnum<QCustomer,Status> status = _alias.status;
    public static PBoolean<QCustomer> inactive = _alias.inactive;
    public static PScalar<QCustomer, PhoneNumber> phoneNumber = _alias.phoneNumber;
    public static PScalarComparable<QCustomer, ValidEmail> email = _alias.email;
    public static PString<QCustomer> name = _alias.name;
    public static PUtilDate<QCustomer> registered = _alias.registered;
    public static PInet<QCustomer> currentInet = _alias.currentInet;
    public static PString<QCustomer> comments = _alias.comments;
    public static QAddress.AssocOne<QCustomer> billingAddress = _alias.billingAddress;
    public static QAddress.AssocOne<QCustomer> shippingAddress = _alias.shippingAddress;
    public static QContact.AssocMany<QCustomer> contacts = _alias.contacts;
    public static PByteArray<QCustomer> photo = _alias.photo;
  }

  /** Association query bean */
  @io.ebean.typequery.Generated("io.ebean.querybean.generator")
  @io.ebean.typequery.TypeQueryBean("v1")
  public static abstract class Assoc<R> extends io.ebean.typequery.TQAssocBean<org.example.domain.Customer,R,QCustomer> {

    public PLong<R> id;
    public PLong<R> version;
    public PTimestamp<R> whenCreated;
    public PTimestamp<R> whenUpdated;
    public PEnum<R,Status> status;
    public PBoolean<R> inactive;
    public PScalar<R, PhoneNumber> phoneNumber;
    public PScalarComparable<R, ValidEmail> email;
    public PString<R> name;
    public PUtilDate<R> registered;
    public PInet<R> currentInet;
    public PString<R> comments;
    public QAddress.AssocOne<R> billingAddress;
    public QAddress.AssocOne<R> shippingAddress;
    public QContact.AssocMany<R> contacts;
    public PByteArray<R> photo;

    protected Assoc(String name, R root) { super(name, root); }
    protected Assoc(String name, R root, String prefix) { super(name, root, prefix); }
  }

  /** Associated ToOne query bean */
  @io.ebean.typequery.Generated("io.ebean.querybean.generator")
  @io.ebean.typequery.TypeQueryBean("v1")
  public static final class AssocOne<R> extends Assoc<R> {
    public AssocOne(String name, R root) { super(name, root); }
    public AssocOne(String name, R root, String prefix) { super(name, root, prefix); }
  }

  /** Associated ToMany query bean */
  @io.ebean.typequery.Generated("io.ebean.querybean.generator")
  @io.ebean.typequery.TypeQueryBean("v1")
  public static final class AssocMany<R> extends Assoc<R> implements io.ebean.typequery.TQAssocMany<org.example.domain.Customer, R, QCustomer>{
    public AssocMany(String name, R root) { super(name, root); }
    public AssocMany(String name, R root, String prefix) { super(name, root, prefix); }

    @Override
    public R filterMany(java.util.function.Consumer<QCustomer> apply) {
      final io.ebean.ExpressionList<org.example.domain.Customer> list = _newExpressionList();
      apply.accept(new QCustomer(list));
      return _filterMany(list);
    }

    @Override
    public R filterMany(io.ebean.ExpressionList<org.example.domain.Customer> filter) { return _filterMany(filter); }

    @Override
    public R filterManyRaw(String rawExpressions, Object... params) { return _filterManyRaw(rawExpressions, params); }

    @Override
    @Deprecated(forRemoval = true)
    public R filterMany(String expressions, Object... params) { return _filterMany(expressions, params); }

    @Override
    public R isEmpty() { return _isEmpty(); }

    @Override
    public R isNotEmpty() { return _isNotEmpty(); }
  }
}