com.mysema.query.collections.ColQuery Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2010 Mysema Ltd.
 * All rights reserved.
 *
 */
package com.mysema.query.collections;

import com.mysema.query.Projectable;
import com.mysema.query.SimpleQuery;
import com.mysema.query.types.CollectionExpression;
import com.mysema.query.types.MapExpression;
import com.mysema.query.types.Path;

/**
 * Query interface for Collection queries
 *
 * @author tiwe
 */
public interface ColQuery extends SimpleQuery, Projectable {

    /**
     * Clone this ColQuery instance and return the clone
     *
     * @return
     */
    ColQuery clone();

    /**
     * Bind the given collection to an already existing query source
     *
     * @param 
     * @param entity Path for the source
     * @param col content of the source
     * @return
     */
     ColQuery bind(Path entity, Iterable col);
    
    /**
     * Add a query source
     *
     * @param 
     * @param entity Path for the source
     * @param col content of the source
     * @return
     */
     ColQuery from(Path entity, Iterable col);

    /**
     * Define an inner join from the Collection typed path to the alias
     *
     * @param 
     * @param collectionPath
     * @param alias
     * @return
     */
    
 ColQuery innerJoin(CollectionExpression collectionPath, Path
 alias);

    /**
     * Define an inner join from the Map typed path to the alias
     *
     * @param 

     * @param mapPath
     * @param alias
     * @return
     */
    
 ColQuery innerJoin(MapExpression mapPath, Path alias);

}