Package org.apache.cayenne.lifecycle.id

Class StringIdQuery

java.lang.Object

org.apache.cayenne.lifecycle.id.StringIdQuery

All Implemented Interfaces:

Serializable, Query

public class StringIdQuery
extends Object
implements Query

A query that allows to fetch objects based on one or more String IDs. The returned objects do not have to be of the same type, be related via inheritance, or come from the same DB table. Note that if you expect multiple types of objects, use ObjectContext.performGenericQuery(Query). The returned QueryResponse will contain separate lists of DataRows for each type in no particular order.

As of this writing, a limitation of this query is that it returns DataRows that need to be manually converted to objects if needed. In that it is similar to QueryChain.

Since:

3.1

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,ObjectSelect>	idQueriesByEntity
protected Collection<String>	stringIds

Constructor Summary

Constructors

Constructor	Description
StringIdQuery(String... stringIds)
StringIdQuery(Collection<String> stringIds)

Method Summary

Modifier and Type	Method	Description
void	addStringIds(String... ids)
SQLAction	createSQLAction(SQLActionVisitor visitor)
protected Map<String,ObjectSelect>	getIdQueriesByEntity(EntityResolver resolver)
QueryMetadata	getMetaData(EntityResolver resolver)
Collection<String>	getStringIds()
void	route(QueryRouter router, EntityResolver resolver, Query substitutedQuery)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

stringIds

protected Collection<String> stringIds

idQueriesByEntity

protected transient Map<String,ObjectSelect> idQueriesByEntity

Constructor Details

StringIdQuery

public StringIdQuery(String... stringIds)

StringIdQuery

public StringIdQuery(Collection<String> stringIds)

Method Details

getStringIds

public Collection<String> getStringIds()

addStringIds

public void addStringIds(String... ids)

getIdQueriesByEntity

protected Map<String,ObjectSelect> getIdQueriesByEntity(EntityResolver resolver)

getMetaData

public QueryMetadata getMetaData(EntityResolver resolver)

Specified by:

getMetaData in interface Query

route

public void route(QueryRouter router,
 EntityResolver resolver,
 Query substitutedQuery)

Specified by:

route in interface Query

createSQLAction

public SQLAction createSQLAction(SQLActionVisitor visitor)

Specified by:

createSQLAction in interface Query