Class CannedQueryDAOImpl

java.lang.Object
org.alfresco.repo.domain.query.AbstractCannedQueryDAOImpl
org.alfresco.repo.domain.query.ibatis.CannedQueryDAOImpl
All Implemented Interfaces:
CannedQueryDAO

public class CannedQueryDAOImpl extends AbstractCannedQueryDAOImpl
DAO implementation providing canned query support.
Since:
3.5
Author:
Derek Hulley
  • Constructor Details

    • CannedQueryDAOImpl

      public CannedQueryDAOImpl()
  • Method Details

    • setSqlSessionTemplate

      public final void setSqlSessionTemplate(org.mybatis.spring.SqlSessionTemplate sqlSessionTemplate)
    • init

      public void init()
      Description copied from class: AbstractCannedQueryDAOImpl
      Checks that properties have been set
      Overrides:
      init in class AbstractCannedQueryDAOImpl
    • executeCountQuery

      public Long executeCountQuery(String sqlNamespace, String queryName, Object parameterObj)
      Execute a count(*)-style query returning a count value. The implementation will ensure that null is substituted with 0, if required.

      All exceptions can be safely caught and handled as required.

      Only one return value is allowed and is checked to prevent null returns.

      Parameters:
      sqlNamespace - the query namespace (defined by config file) e.g. alfresco.query.usage
      queryName - the name of the query e.g. select_userCount
      parameterObj - the values to drive the selection (may be null if not required)
      Returns:
      a non-null count
    • executeQueryUnique

      public <R> R executeQueryUnique(String sqlNamespace, String queryName, Object parameterObj)
      Description copied from interface: CannedQueryDAO
      Execute a query that returns exactly one result. The assumption is that the parameters provided uniquely identify the object.
      Type Parameters:
      R - the return value's type
      Parameters:
      sqlNamespace - the query namespace (defined by config file) e.g. alfresco.query.usage
      queryName - the name of the query e.g. select_userCount
      parameterObj - the values to drive the selection (may be null if not required)
      Returns:
      the unique result (never null)
    • executeQuery

      public <R> List<R> executeQuery(String sqlNamespace, String queryName, Object parameterObj, int offset, int limit)
      Description copied from interface: CannedQueryDAO
      Execute a query that returns one or more results.
      Type Parameters:
      R - the return value's type
      Parameters:
      sqlNamespace - the query namespace (defined by config file) e.g. alfresco.query.usage
      queryName - the name of the query e.g. select_userCount
      parameterObj - the values to drive the selection (may be null if not required)
      offset - the number of results to skip
      limit - the maximum number of results to retrieve or Integer.MAX_VALUE for no limit
      Returns:
      the list of results
    • executeQuery

      public <R> void executeQuery(String sqlNamespace, String queryName, Object parameterObj, int offset, int limit, CannedQueryDAO.ResultHandler<R> handler)
      Description copied from interface: CannedQueryDAO
      Execute a query that returns one or more results, processing the results using a handler.
      Type Parameters:
      R - the return value's type
      Parameters:
      sqlNamespace - the query namespace (defined by config file) e.g. alfresco.query.usage
      queryName - the name of the query e.g. select_userCount
      parameterObj - the values to drive the selection (may be null if not required)
      offset - the number of results to skip
      limit - the maximum number of results to retrieve or Integer.MAX_VALUE for no limit