Torpedo (TorpedoQuery 2.5.4 API)

java.lang.Object
- org.torpedoquery.jpa.TorpedoFunction
- - org.torpedoquery.jpa.Torpedo

```
public class Torpedo
extends TorpedoFunction
```
Torpedo Query goal is to simplify how you create and maintain your HQL and JPA-QL query. First add this import static org.torpedoquery.jpa.Torpedo.*; 1. Create simple select final Entity entity = from(Entity.class); org.torpedoquery.jpa.Query<Entity> select = select(entity); 2. Create scalar queries final Entity entity = from(Entity.class); org.torpedoquery.jpa.Query<String> select = select(entity.getCode()); 3. How to execute your query final Entity entity = from(Entity.class); org.torpedoquery.jpa.Query<Entity> select = select(entity); List<Entity> entityList = select.list(entityManager); 4. Create simple condition final Entity entity = from(Entity.class); where(entity.getCode()).eq("mycode"); org.torpedoquery.jpa.Query<Entity> select = select(entity); 5. Create join on your entities final Entity entity = from(Entity.class); final SubEntity subEntity = innerJoin(entity.getSubEntities()); org.torpedoquery.jpa.Query<String[]> select = select(entity.getCode(), subEntity.getName()); 6. Group your conditions Entity from = from(Entity.class); OnGoingLogicalCondition condition = condition(from.getCode()).eq("test").or(from.getCode()).eq("test2"); where(from.getName()).eq("test").and(condition); Query<Entity> select = select(from);

Version:

$Id: $Id

Author:

xjodoin

Constructor Summary

Constructors
Constructor and Description

Torpedo()

Constructors
Constructor and Description
`Torpedo()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static OnGoingLogicalCondition`	`and(Iterable<OnGoingLogicalCondition> conditions)` Group expressions together in a single conjunction (A and B and C...)
`static OnGoingLogicalCondition`	`and(OnGoingLogicalCondition... conditions)` and.
`static OnGoingLogicalCondition`	`condition()` condition.
`static <T> OnGoingCollectionCondition<T>`	`condition(Collection<T> object)` condition.
`static <V,T extends Comparable<V>> OnGoingComparableCondition<V>`	`condition(ComparableFunction<T> object)` condition.
`static OnGoingStringCondition<String>`	`condition(Function<String> object)` condition.
`static <T> OnGoingLogicalCondition`	`condition(OnGoingLogicalCondition condition)` condition.
`static OnGoingStringCondition<String>`	`condition(String object)` condition.
`static <T> ValueOnGoingCondition<T>`	`condition(T object)` Create a group condition ex: (myObject.myField is not null and myObject.intField > 2) this condition is not bind to any query builder until you pass it to the @see `where(Object)` or to a ValueOnGoingCondition create by a where
`static <V,T extends Comparable<V>> OnGoingComparableCondition<V>`	`condition(T object)` condition.
`static <T,E extends T> E`	`extend(T toExtend, Class<E> subclass)` In HQL you can specify field is only in subclass Entity from = from(Entity.class); ExtendEntity extend = extend(from, ExtendEntity.class); where(extend.getSpecificField()).eq("test");
`static <T> T`	`from(Class<T> toQuery)` MyObject queryBuilder = from(MyObject.class);
`static OnGoingGroupByCondition`	`groupBy(Object... values)` Add group by to the relative query builder
`static <T> JoinBuilder<T>`	`innerJoin(Class<T> toJoin)` innerJoin.
`static <T> T`	`innerJoin(Collection<T> toJoin)` innerJoin.
`static <T,E extends T> E`	`innerJoin(Collection<T> toJoin, Class<E> realType)` innerJoin.
`static <T> T`	`innerJoin(Map<?,T> toJoin)` innerJoin.
`static <T,E extends T> E`	`innerJoin(Map<?,T> toJoin, Class<E> realType)` innerJoin.
`static <T> T`	`innerJoin(T toJoin)` Create HQL inner join
`static <T,E extends T> E`	`innerJoin(T toJoin, Class<E> realType)` Create HQL inner join
`static <T> JoinBuilder<T>`	`leftJoin(Class<T> toJoin)` leftJoin.
`static <T> T`	`leftJoin(Collection<T> toJoin)` leftJoin.
`static <T,E extends T> E`	`leftJoin(Collection<T> toJoin, Class<E> realType)` leftJoin.
`static <T> T`	`leftJoin(Map<?,T> toJoin)` leftJoin.
`static <T,E extends T> E`	`leftJoin(Map<?,T> toJoin, Class<E> realType)` leftJoin.
`static <T> T`	`leftJoin(T toJoin)` Create HQL left join
`static <T,E extends T> E`	`leftJoin(T toJoin, Class<E> realType)` Create HQL left join
`static OnGoingLogicalCondition`	`or(Iterable<OnGoingLogicalCondition> conditions)` or.
`static OnGoingLogicalCondition`	`or(OnGoingLogicalCondition... conditions)` Group expressions together in a single disjunction (A or B or C...)
`static void`	`orderBy(Object... values)` Add order by to the relative query
`static <T> T`	`param(T param)` param.
`static <T> JoinBuilder<T>`	`rightJoin(Class<T> toJoin)` rightJoin.
`static <T> T`	`rightJoin(Collection<T> toJoin)` rightJoin.
`static <T,E extends T> E`	`rightJoin(Collection<T> toJoin, Class<E> realType)` rightJoin.
`static <T> T`	`rightJoin(Map<?,T> toJoin)` rightJoin.
`static <T,E extends T> E`	`rightJoin(Map<?,T> toJoin, Class<E> realType)` rightJoin.
`static <T> T`	`rightJoin(T toJoin)` Create HQL right join
`static <T,E extends T> E`	`rightJoin(T toJoin, Class<E> realType)` Create HQL right join
`static <T> Query<T>`	`select(Function<T> value)` select.
`static Query<Object[]>`	`select(Object... values)` select.
`static <T> Query<T>`	`select(T value)` in TorpedoQuery the select method finalize your query.
`static <T> OnGoingCollectionCondition<T>`	`where(Collection<T> object)` where.
`static <T> OnGoingComparableCondition<T>`	`where(ComparableFunction<T> object)` where.
`static OnGoingStringCondition<String>`	`where(Function<String> function)` where.
`static <T> OnGoingLogicalCondition`	`where(OnGoingLogicalCondition condition)` Apply where condition to the query relative to the parameter.
`static OnGoingStringCondition<String>`	`where(String object)` where.
`static <T> ValueOnGoingCondition<T>`	`where(T object)` Apply where condition to the query relative to the parameter.
`static <V,T extends Comparable<V>> OnGoingComparableCondition<V>`	`where(T object)` where.
`static <T> OnGoingCollectionCondition<T>`	`with(Collection<T> object)` with.
`static <T> OnGoingLogicalCondition`	`with(OnGoingLogicalCondition condition)` with.
`static OnGoingStringCondition<String>`	`with(String object)` with.
`static <T> ValueOnGoingCondition<T>`	`with(T object)` Create hql restriction directly onto hql join ex: inner join myObject.getMyJoinObject() joinObject with joinObject.myField is not null
`static <V,T extends Comparable<V>> OnGoingComparableCondition<V>`	`with(T object)` with.

Methods inherited from class org.torpedoquery.jpa.TorpedoFunction
asc, avg, avg, coalesce, coalesce, comparableFunction, constant, constant, count, desc, distinct, dyn, function, index, length, length, lower, lower, max, max, min, min, operation, operation, substring, substring, sum, sum, trim, trim, upper, upper

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Torpedo
```
public Torpedo()
```
- Method Detail
  - from
```
public static <T> T from(Class<T> toQuery)
```
    MyObject queryBuilder = from(MyObject.class);
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toQuery - a Class object.
    
    Returns:
    
    a query builder proxy
  - extend
```
public static <T,E extends T> E extend(T toExtend,
                                       Class<E> subclass)
```
    In HQL you can specify field is only in subclass Entity from = from(Entity.class); ExtendEntity extend = extend(from, ExtendEntity.class); where(extend.getSpecificField()).eq("test");
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toExtend - a T object.
    
    subclass - a Class object.
    
    Returns:
    
    a E object.
  - select
```
public static <T> Query<T> select(Function<T> value)
```
    select.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    value - a Function object.
    
    Returns:
    
    a Query object.
    
    See Also:
    
    select(Object)
  - select
```
public static <T> Query<T> select(T value)
```
    in TorpedoQuery the select method finalize your query.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    value - a T object.
    
    Returns:
    
    Return your unexecute Query object
  - select
```
public static Query<Object[]> select(Object... values)
```
    select.
    
    Parameters:
    
    values - a Object object.
    
    Returns:
    
    a Query object.
    
    See Also:
    
    select(Object)
  - innerJoin
```
public static <T> T innerJoin(T toJoin)
```
    Create HQL inner join
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a T object.
    
    Returns:
    
    a query builder proxy
  - innerJoin
```
public static <T,E extends T> E innerJoin(T toJoin,
                                          Class<E> realType)
```
    Create HQL inner join
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a T object.
    
    realType - a Class object.
    
    Returns:
    
    a query builder proxy
  - innerJoin
```
public static <T> T innerJoin(Collection<T> toJoin)
```
    innerJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Collection object.
    
    Returns:
    
    a T object.
    
    See Also:
    
    innerJoin(Object)
  - innerJoin
```
public static <T,E extends T> E innerJoin(Collection<T> toJoin,
                                          Class<E> realType)
```
    innerJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Collection object.
    
    realType - a Class object.
    
    Returns:
    
    a E object.
    
    See Also:
    
    innerJoin(Object, Class)
  - innerJoin
```
public static <T> T innerJoin(Map<?,T> toJoin)
```
    innerJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Map object.
    
    Returns:
    
    a T object.
    
    See Also:
    
    innerJoin(Object)
  - innerJoin
```
public static <T,E extends T> E innerJoin(Map<?,T> toJoin,
                                          Class<E> realType)
```
    innerJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Map object.
    
    realType - a Class object.
    
    Returns:
    
    a E object.
    
    See Also:
    
    innerJoin(Object, Class)
  - innerJoin
```
public static <T> JoinBuilder<T> innerJoin(Class<T> toJoin)
```
    innerJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Class object.
    
    Returns:
    
    a query builder T object.
  - leftJoin
```
public static <T> JoinBuilder<T> leftJoin(Class<T> toJoin)
```
    leftJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Class object.
    
    Returns:
    
    a query builder T object.
  - rightJoin
```
public static <T> JoinBuilder<T> rightJoin(Class<T> toJoin)
```
    rightJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Class object.
    
    Returns:
    
    a query builder T object.
  - leftJoin
```
public static <T> T leftJoin(T toJoin)
```
    Create HQL left join
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a T object.
    
    Returns:
    
    a query builder proxy
  - leftJoin
```
public static <T,E extends T> E leftJoin(T toJoin,
                                         Class<E> realType)
```
    Create HQL left join
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a T object.
    
    realType - a Class object.
    
    Returns:
    
    a query builder proxy
  - leftJoin
```
public static <T> T leftJoin(Collection<T> toJoin)
```
    leftJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Collection object.
    
    Returns:
    
    a T object.
    
    See Also:
    
    leftJoin(Object)
  - leftJoin
```
public static <T,E extends T> E leftJoin(Collection<T> toJoin,
                                         Class<E> realType)
```
    leftJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Collection object.
    
    realType - a Class object.
    
    Returns:
    
    a E object.
    
    See Also:
    
    leftJoin(Object, Class)
  - leftJoin
```
public static <T> T leftJoin(Map<?,T> toJoin)
```
    leftJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Map object.
    
    Returns:
    
    a T object.
    
    See Also:
    
    leftJoin(Object)
  - leftJoin
```
public static <T,E extends T> E leftJoin(Map<?,T> toJoin,
                                         Class<E> realType)
```
    leftJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Map object.
    
    realType - a Class object.
    
    Returns:
    
    a E object.
    
    See Also:
    
    leftJoin(Object, Class)
  - rightJoin
```
public static <T> T rightJoin(T toJoin)
```
    Create HQL right join
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a T object.
    
    Returns:
    
    a query builder proxy
  - rightJoin
```
public static <T,E extends T> E rightJoin(T toJoin,
                                          Class<E> realType)
```
    Create HQL right join
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a T object.
    
    realType - a Class object.
    
    Returns:
    
    a query builder proxy
  - rightJoin
```
public static <T> T rightJoin(Collection<T> toJoin)
```
    rightJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Collection object.
    
    Returns:
    
    a T object.
    
    See Also:
    
    rightJoin(Object)
  - rightJoin
```
public static <T,E extends T> E rightJoin(Collection<T> toJoin,
                                          Class<E> realType)
```
    rightJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Collection object.
    
    realType - a Class object.
    
    Returns:
    
    a E object.
    
    See Also:
    
    rightJoin(Object, Class)
  - rightJoin
```
public static <T> T rightJoin(Map<?,T> toJoin)
```
    rightJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Map object.
    
    Returns:
    
    a T object.
    
    See Also:
    
    rightJoin(Object)
  - rightJoin
```
public static <T,E extends T> E rightJoin(Map<?,T> toJoin,
                                          Class<E> realType)
```
    rightJoin.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    toJoin - a Map object.
    
    realType - a Class object.
    
    Returns:
    
    a E object.
    
    See Also:
    
    rightJoin(Object, Class)
  - where
```
public static <T> ValueOnGoingCondition<T> where(T object)
```
    Apply where condition to the query relative to the parameter.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    object - a T object.
    
    Returns:
    
    a condition builder
  - where
```
public static <T> OnGoingLogicalCondition where(OnGoingLogicalCondition condition)
```
    Apply where condition to the query relative to the parameter.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    condition - group create by @see condition(Object)
    
    Returns:
    
    a condition builder
  - where
```
public static <V,T extends Comparable<V>> OnGoingComparableCondition<V> where(T object)
```
    where.
    
    Type Parameters:
    
    V - a V object.
    
    Parameters:
    
    object - a T object.
    
    Returns:
    
    a OnGoingComparableCondition object.
    
    See Also:
    
    where(Object)
  - where
```
public static OnGoingStringCondition<String> where(String object)
```
    where.
    
    Parameters:
    
    object - a String object.
    
    Returns:
    
    a OnGoingStringCondition object.
    
    See Also:
    
    where(Object)
  - where
```
public static OnGoingStringCondition<String> where(Function<String> function)
```
    where.
    
    Parameters:
    
    function - a Function object.
    
    Returns:
    
    a OnGoingStringCondition object.
  - where
```
public static <T> OnGoingCollectionCondition<T> where(Collection<T> object)
```
    where.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    object - a Collection object.
    
    Returns:
    
    a OnGoingCollectionCondition object.
    
    See Also:
    
    where(Object)
  - where
```
public static <T> OnGoingComparableCondition<T> where(ComparableFunction<T> object)
```
    where.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    object - a ComparableFunction object.
    
    Returns:
    
    a OnGoingComparableCondition object.
    
    See Also:
    
    where(Object)
  - with
```
public static <T> ValueOnGoingCondition<T> with(T object)
```
    Create hql restriction directly onto hql join ex: inner join myObject.getMyJoinObject() joinObject with joinObject.myField is not null
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    object - a T object.
    
    Returns:
    
    a condition builder
  - with
```
public static <V,T extends Comparable<V>> OnGoingComparableCondition<V> with(T object)
```
    with.
    
    Type Parameters:
    
    V - a V object.
    
    Parameters:
    
    object - a T object.
    
    Returns:
    
    a OnGoingComparableCondition object.
    
    See Also:
    
    with(Object)
  - with
```
public static OnGoingStringCondition<String> with(String object)
```
    with.
    
    Parameters:
    
    object - a String object.
    
    Returns:
    
    a OnGoingStringCondition object.
    
    See Also:
    
    with(Object)
  - with
```
public static <T> OnGoingCollectionCondition<T> with(Collection<T> object)
```
    with.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    object - a Collection object.
    
    Returns:
    
    a OnGoingCollectionCondition object.
    
    See Also:
    
    with(Object)
  - with
```
public static <T> OnGoingLogicalCondition with(OnGoingLogicalCondition condition)
```
    with.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    condition - a OnGoingLogicalCondition object.
    
    Returns:
    
    a OnGoingLogicalCondition object.
    
    See Also:
    
    with(Object)
  - condition
```
public static <T> ValueOnGoingCondition<T> condition(T object)
```
    Create a group condition ex: (myObject.myField is not null and myObject.intField > 2) this condition is not bind to any query builder until you pass it to the @see where(Object) or to a ValueOnGoingCondition create by a where
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    object - a T object.
    
    Returns:
    
    a condition builder
  - condition
```
public static <V,T extends Comparable<V>> OnGoingComparableCondition<V> condition(T object)
```
    condition.
    
    Type Parameters:
    
    V - a V object.
    
    Parameters:
    
    object - a T object.
    
    Returns:
    
    a OnGoingComparableCondition object.
    
    See Also:
    
    condition(Object)
  - condition
```
public static <V,T extends Comparable<V>> OnGoingComparableCondition<V> condition(ComparableFunction<T> object)
```
    condition.
    
    Type Parameters:
    
    V - a V object.
    
    Parameters:
    
    object - a ComparableFunction object.
    
    Returns:
    
    a OnGoingComparableCondition object.
    
    See Also:
    
    condition(Object)
  - condition
```
public static OnGoingStringCondition<String> condition(String object)
```
    condition.
    
    Parameters:
    
    object - a String object.
    
    Returns:
    
    a OnGoingStringCondition object.
    
    See Also:
    
    condition(Object)
  - condition
```
public static OnGoingStringCondition<String> condition(Function<String> object)
```
    condition.
    
    Parameters:
    
    object - a Function object.
    
    Returns:
    
    a OnGoingStringCondition object.
    
    See Also:
    
    condition(Object)
  - condition
```
public static <T> OnGoingCollectionCondition<T> condition(Collection<T> object)
```
    condition.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    object - a Collection object.
    
    Returns:
    
    a OnGoingCollectionCondition object.
    
    See Also:
    
    condition(Object)
  - condition
```
public static <T> OnGoingLogicalCondition condition(OnGoingLogicalCondition condition)
```
    condition.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    condition - a OnGoingLogicalCondition object.
    
    Returns:
    
    a OnGoingLogicalCondition object.
    
    See Also:
    
    condition(Object)
  - condition
```
public static OnGoingLogicalCondition condition()
```
    condition.
    
    Returns:
    
    a OnGoingLogicalCondition object.
  - and
```
public static OnGoingLogicalCondition and(OnGoingLogicalCondition... conditions)
```
    and.
    
    Parameters:
    
    conditions - a OnGoingLogicalCondition object.
    
    Returns:
    
    a OnGoingLogicalCondition object.
  - and
```
public static OnGoingLogicalCondition and(Iterable<OnGoingLogicalCondition> conditions)
```
    Group expressions together in a single conjunction (A and B and C...)
    
    Parameters:
    
    conditions - a Iterable object.
    
    Returns:
    
    OnGoingLogicalCondition
  - or
```
public static OnGoingLogicalCondition or(OnGoingLogicalCondition... conditions)
```
    Group expressions together in a single disjunction (A or B or C...)
    
    Parameters:
    
    conditions - a OnGoingLogicalCondition object.
    
    Returns:
    
    OnGoingLogicalCondition
  - or
```
public static OnGoingLogicalCondition or(Iterable<OnGoingLogicalCondition> conditions)
```
    or.
    
    Parameters:
    
    conditions - a Iterable object.
    
    Returns:
    
    a OnGoingLogicalCondition object.
  - groupBy
```
public static OnGoingGroupByCondition groupBy(Object... values)
```
    Add group by to the relative query builder
    
    Parameters:
    
    values - a Object object.
    
    Returns:
    
    group by condition builder
  - orderBy
```
public static void orderBy(Object... values)
```
    Add order by to the relative query
    
    Parameters:
    
    values - a Object object.
  - param
```
public static <T> T param(T param)
```
    param.
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    param - a T object.
    
    Returns:
    
    a T object.

Class Torpedo

Constructor Summary

Method Summary

Methods inherited from class org.torpedoquery.jpa.TorpedoFunction

Methods inherited from class java.lang.Object

Constructor Detail

Torpedo

Method Detail

from

extend

select

select

select

innerJoin

innerJoin

innerJoin

innerJoin

innerJoin

innerJoin

innerJoin

leftJoin

rightJoin

leftJoin

leftJoin

leftJoin

leftJoin

leftJoin

leftJoin

rightJoin

rightJoin

rightJoin

rightJoin

rightJoin

rightJoin

where

where

where

where

where

where

where

with

with

with

with

with

condition

condition

condition

condition

condition

condition

condition

condition

and

and

or

or

groupBy

orderBy

param