Executor.java

  1. /*
  2.  *    Copyright 2009-2023 the original author or authors.
  3.  *
  4.  *    Licensed under the Apache License, Version 2.0 (the "License");
  5.  *    you may not use this file except in compliance with the License.
  6.  *    You may obtain a copy of the License at
  7.  *
  8.  *       https://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  *    Unless required by applicable law or agreed to in writing, software
  11.  *    distributed under the License is distributed on an "AS IS" BASIS,
  12.  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  *    See the License for the specific language governing permissions and
  14.  *    limitations under the License.
  15.  */
  16. package org.apache.ibatis.executor;

  17. import java.sql.SQLException;
  18. import java.util.List;

  19. import org.apache.ibatis.cache.CacheKey;
  20. import org.apache.ibatis.cursor.Cursor;
  21. import org.apache.ibatis.mapping.BoundSql;
  22. import org.apache.ibatis.mapping.MappedStatement;
  23. import org.apache.ibatis.reflection.MetaObject;
  24. import org.apache.ibatis.session.ResultHandler;
  25. import org.apache.ibatis.session.RowBounds;
  26. import org.apache.ibatis.transaction.Transaction;

  27. /**
  28.  * @author Clinton Begin
  29.  */
  30. public interface Executor {

  31.   ResultHandler NO_RESULT_HANDLER = null;

  32.   int update(MappedStatement ms, Object parameter) throws SQLException;

  33.   <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler,
  34.       CacheKey cacheKey, BoundSql boundSql) throws SQLException;

  35.   <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler)
  36.       throws SQLException;

  37.   <E> Cursor<E> queryCursor(MappedStatement ms, Object parameter, RowBounds rowBounds) throws SQLException;

  38.   List<BatchResult> flushStatements() throws SQLException;

  39.   void commit(boolean required) throws SQLException;

  40.   void rollback(boolean required) throws SQLException;

  41.   CacheKey createCacheKey(MappedStatement ms, Object parameterObject, RowBounds rowBounds, BoundSql boundSql);

  42.   boolean isCached(MappedStatement ms, CacheKey key);

  43.   void clearLocalCache();

  44.   void deferLoad(MappedStatement ms, MetaObject resultObject, String property, CacheKey key, Class<?> targetType);

  45.   Transaction getTransaction();

  46.   void close(boolean forceRollback);

  47.   boolean isClosed();

  48.   void setExecutorWrapper(Executor executor);

  49. }