to.etc.webapp.query

Interface IQueryExecutor<C extends QDataContext>

All Known Implementing Classes:

JdbcQueryExecutor

public interface IQueryExecutor<C extends QDataContext>

Method Summary

Modifier and Type	Method and Description
void	attach(C root, Object o)
void	delete(C root, Object o) Cause the object to be deleted from the database.
<T> T	find(C root, Class<T> clz, Object pk) Load the persistent object with the specified type and primary key from the database.
<T> T	find(C root, ICriteriaTableDef<T> metatable, Object pk)
<T> T	getInstance(C root, Class<T> clz, Object pk) Load the persistent object with the specified type and primary key from the database.
<T> T	getInstance(C root, ICriteriaTableDef<T> clz, Object pk)
<T> List<T>	query(C root, QCriteria<T> q) Execute the query specified by q and return a list of results.
List<Object[]>	query(C root, QSelection<?> sel) Issue a selection query, where multiple fields or projections on fields are selected from a base class.
void	refresh(C root, Object o) Refresh with latest content in the database.
void	save(C root, Object o) Cause the object to be inserted in the database.

Method Detail

query

@Nonnull
<T> List<T> query(@Nonnull
                           C root,
                           @Nonnull
                           QCriteria<T> q)
                    throws Exception

Execute the query specified by q and return a list of results. Before and after the query execution all registered listeners will be called.

Type Parameters:

T - The return type for this query, a persistent class type

Parameters:

q - The selection criteria

Returns:

Throws:

Exception

query

@Nonnull
List<Object[]> query(@Nonnull
                              C root,
                              @Nonnull
                              QSelection<?> sel)
                       throws Exception

Issue a selection query, where multiple fields or projections on fields are selected from a base class.

Parameters:

sel -

Returns:

Throws:

Exception

find

@Nullable
<T> T find(@Nonnull
                     C root,
                     @Nonnull
                     Class<T> clz,
                     @Nonnull
                     Object pk)
              throws Exception

Load the persistent object with the specified type and primary key from the database. This will execute an actual select in the database if the object is not yet cached, ensuring that the object actually exists. If the object does not exist this will return null.

Type Parameters:

T - The object type.

Parameters:

clz - The persistent class for which an instance is being sought.

pk - The PK for the instance required.

Returns:

Null if the instance does not exist, the actual and fully initialized instance (or proxy) otherwise.

Throws:

Exception

find

@Nullable
<T> T find(@Nonnull
                     C root,
                     @Nonnull
                     ICriteriaTableDef<T> metatable,
                     @Nonnull
                     Object pk)
              throws Exception

Throws:

Exception

getInstance

@Nonnull
<T> T getInstance(@Nonnull
                           C root,
                           @Nonnull
                           Class<T> clz,
                           @Nonnull
                           Object pk)
                    throws Exception

Load the persistent object with the specified type and primary key from the database. This will return an object always even if the object does not exist in the database! This should only be used when you need an instance representing a given primary key that you know exists. This usually returns a proxy, meaning that nonexistent objects will throw exceptions as soon as properties other than it's primary key are accessed. To get an object and be sure it is present in the database use QDataContext.find(Class, Object).

Type Parameters:

T - The object type

Parameters:

clz - The persistent class for which an instance is being sought.

pk - The PK for the instance required.

Returns:

Always returns an instance; it can be invalid when it does not really exist on the backing store.

Throws:

Exception

getInstance

@Nonnull
<T> T getInstance(@Nonnull
                           C root,
                           @Nonnull
                           ICriteriaTableDef<T> clz,
                           @Nonnull
                           Object pk)
                    throws Exception

Throws:

Exception

save

void save(@Nonnull
          C root,
          @Nonnull
          Object o)
   throws Exception

Cause the object to be inserted in the database.

Parameters:

o -

Throws:

Exception

refresh

void refresh(@Nonnull
             C root,
             @Nonnull
             Object o)
      throws Exception

Refresh with latest content in the database.

Parameters:

o -

Throws:

Exception

delete

void delete(@Nonnull
            C root,
            @Nonnull
            Object o)
     throws Exception

Cause the object to be deleted from the database.

Parameters:

o -

Throws:

Exception

attach

void attach(@Nonnull
            C root,
            @Nonnull
            Object o)
     throws Exception

Throws:

Exception