com.mysema.query.jdo

Class AbstractJDOQuery<Q extends AbstractJDOQuery<Q>>

java.lang.Object

com.mysema.query.support.QueryBase<Q>

com.mysema.query.support.ProjectableQuery<Q>

com.mysema.query.jdo.AbstractJDOQuery<Q>

Type Parameters:

Q -

All Implemented Interfaces:

FilteredClause<JDOQLQuery>, JDOCommonQuery<JDOQLQuery>, JDOQLQuery, Projectable, Query<JDOQLQuery>, SimpleQuery<JDOQLQuery>, Closeable, AutoCloseable

Direct Known Subclasses:

JDOQuery

public abstract class AbstractJDOQuery<Q extends AbstractJDOQuery<Q>>
extends ProjectableQuery<Q>
implements JDOQLQuery

Abstract base class for custom implementations of the JDOCommonQuery interface.

Author:

tiwe

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	fetchGroups
protected Integer	maxFetchDepth

Fields inherited from class com.mysema.query.support.QueryBase

MDC_PARAMETERS, MDC_QUERY, queryMixin

Constructor Summary

Constructors

Constructor and Description
AbstractJDOQuery(javax.jdo.PersistenceManager persistenceManager)
AbstractJDOQuery(javax.jdo.PersistenceManager persistenceManager, JDOQLTemplates templates, QueryMetadata metadata, boolean detach)

Method Summary

Methods

Modifier and Type	Method and Description
Q	addFetchGroup(String fetchGroupName) Add the fetch group to the set of active fetch groups.
protected void	cleanupMDC()
void	close() Close the query and related resources
long	count() return the amount of matched rows
boolean	exists()
Q	from(EntityPath<?>... args) Add query sources
QueryMetadata	getMetadata()
JDOQLTemplates	getTemplates()
boolean	isDetach()
com.mysema.commons.lang.CloseableIterator<Tuple>	iterate(Expression<?>... args) iterate over the results for the given projection
<RT> com.mysema.commons.lang.CloseableIterator<RT>	iterate(Expression<RT> projection) iterate over the results for the given projection
List<Tuple>	list(Expression<?>... args) list the results for the given projection An empty list is returned for no results.
<RT> List<RT>	list(Expression<RT> expr) list the results for the given projection An empty list is returned for no results.
SearchResults<Tuple>	listResults(Expression<?>... args) list the results for the given projection
<RT> SearchResults<RT>	listResults(Expression<RT> expr) list the results for the given projection
protected void	logQuery(String queryString, Map<Object,String> parameters)
Q	setMaxFetchDepth(int depth) Set the maximum fetch depth when fetching.
String	toString()
Tuple	uniqueResult(Expression<?>... args) return a unique result for the given projection or null if no result is found
<RT> RT	uniqueResult(Expression<RT> expr) return a unique result for the given projection or null if no result is found

Methods inherited from class com.mysema.query.support.ProjectableQuery

map, notExists, singleResult, singleResult, transform, uniqueResult

Methods inherited from class com.mysema.query.support.QueryBase

distinct, equals, groupBy, groupBy, hashCode, having, having, limit, offset, orderBy, orderBy, restrict, set, where, where

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.mysema.query.jdo.JDOQLQuery

clone

Methods inherited from interface com.mysema.query.Query

groupBy, having

Methods inherited from interface com.mysema.query.SimpleQuery

distinct, limit, offset, orderBy, restrict, set

Methods inherited from interface com.mysema.query.FilteredClause

where

Methods inherited from interface com.mysema.query.Projectable

map, notExists, singleResult, singleResult, transform

Field Detail

fetchGroups

protected final Set<String> fetchGroups

maxFetchDepth

@Nullable
protected Integer maxFetchDepth

Constructor Detail

AbstractJDOQuery

public AbstractJDOQuery(@Nullable
                javax.jdo.PersistenceManager persistenceManager)

AbstractJDOQuery

public AbstractJDOQuery(@Nullable
                javax.jdo.PersistenceManager persistenceManager,
                JDOQLTemplates templates,
                QueryMetadata metadata,
                boolean detach)

Method Detail

addFetchGroup

public Q addFetchGroup(String fetchGroupName)

Add the fetch group to the set of active fetch groups.

Specified by:

addFetchGroup in interface JDOQLQuery

Parameters:

fetchGroupName -

Returns:

close

public void close()

Close the query and related resources

Specified by:

close in interface JDOQLQuery

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

count

public long count()

Description copied from interface: Projectable

return the amount of matched rows

Specified by:

count in interface Projectable

exists

public boolean exists()

Specified by:

exists in interface Projectable

Returns:

true, if rows matching the given criteria exist, otherwise false

logQuery

protected void logQuery(String queryString,
            Map<Object,String> parameters)

cleanupMDC

protected void cleanupMDC()

from

public Q from(EntityPath<?>... args)

Description copied from interface: JDOCommonQuery

Add query sources

Specified by:

from in interface JDOCommonQuery<JDOQLQuery>

Returns:

getMetadata

public QueryMetadata getMetadata()

getTemplates

public JDOQLTemplates getTemplates()

isDetach

public boolean isDetach()

iterate

public com.mysema.commons.lang.CloseableIterator<Tuple> iterate(Expression<?>... args)

Description copied from interface: Projectable

iterate over the results for the given projection

Specified by:

iterate in interface Projectable

Returns:

iterate

public <RT> com.mysema.commons.lang.CloseableIterator<RT> iterate(Expression<RT> projection)

Description copied from interface: Projectable

iterate over the results for the given projection

Specified by:

iterate in interface Projectable

Type Parameters:

RT - generic type of the Iterator

Returns:

an Iterator over the projection

list

public List<Tuple> list(Expression<?>... args)

Description copied from interface: Projectable

list the results for the given projection An empty list is returned for no results.

Specified by:

list in interface Projectable

Overrides:

list in class ProjectableQuery<Q extends AbstractJDOQuery<Q>>

Returns:

list

public <RT> List<RT> list(Expression<RT> expr)

Description copied from interface: Projectable

list the results for the given projection An empty list is returned for no results.

Specified by:

list in interface Projectable

Overrides:

list in class ProjectableQuery<Q extends AbstractJDOQuery<Q>>

Type Parameters:

RT - generic type of the List

Returns:

a List over the projection

listResults

public SearchResults<Tuple> listResults(Expression<?>... args)

Description copied from interface: Projectable

list the results for the given projection

Specified by:

listResults in interface Projectable

Returns:

listResults

public <RT> SearchResults<RT> listResults(Expression<RT> expr)

Description copied from interface: Projectable

list the results for the given projection

Specified by:

listResults in interface Projectable

Returns:

setMaxFetchDepth

public Q setMaxFetchDepth(int depth)

Set the maximum fetch depth when fetching. A value of 0 has no meaning and will throw a JDOUserException. A value of -1 means that no limit is placed on fetching. A positive integer will result in that number of references from the initial object to be fetched.

Specified by:

setMaxFetchDepth in interface JDOQLQuery

Parameters:

depth -

Returns:

toString

public String toString()

Overrides:

toString in class QueryBase<Q extends AbstractJDOQuery<Q>>

uniqueResult

@Nullable
public Tuple uniqueResult(Expression<?>... args)

Description copied from interface: Projectable

return a unique result for the given projection or null if no result is found

There is some ambiguity for missing results and null valued results, for disambiguation use the list or iterate methods instead.

Specified by:

uniqueResult in interface Projectable

Returns:

uniqueResult

@Nullable
public <RT> RT uniqueResult(Expression<RT> expr)

Description copied from interface: Projectable

return a unique result for the given projection or null if no result is found

There is some ambiguity for missing results and null valued results, for disambiguation use the list or iterate methods instead.

Specified by:

uniqueResult in interface Projectable

Type Parameters:

RT - return type

Returns:

the result or null for an empty result