org.apache.ojb.broker.accesslayer

Interface QueryCustomizer

All Superinterfaces:

AttributeContainer, java.io.Serializable

All Known Implementing Classes:

QueryCustomizerDefaultImpl

public interface QueryCustomizer
extends AttributeContainer

Interface for QueryCustomizer in CollectionDescriptor

 ...
   
   
 ...
 

If the customized Query is null execution of PB retrieveCollection is skipped and an empty Collection is placed in the relationship attribute.

Version:

$Id: QueryCustomizer.java 365232 2005-12-21 22:36:07Z tomdz $

Author:

Jakob Braeuchi

See Also:

PersistenceBroker.getCollectionByQuery(org.apache.ojb.broker.query.Query)

Method Summary

Methods

Modifier and Type	Method and Description
Query	customizeQuery(java.lang.Object anObject, PersistenceBroker aBroker, CollectionDescriptor aCod, QueryByCriteria aQuery) Return a new Query based on the original Query, the originator object and the additional Attributes.

Methods inherited from interface org.apache.ojb.broker.metadata.AttributeContainer

addAttribute, getAttribute, getAttribute

Method Detail

customizeQuery

Query customizeQuery(java.lang.Object anObject,
                   PersistenceBroker aBroker,
                   CollectionDescriptor aCod,
                   QueryByCriteria aQuery)

Return a new Query based on the original Query, the originator object and the additional Attributes.

Parameters:

anObject - the originator object

aBroker - the PersistenceBroker

aCod - the CollectionDescriptor

aQuery - the original 1:n-Query

Returns:

Query the customized 1:n-Query, return null to skip execution of the query