Module org.seasar.doma.core

Package org.seasar.doma.jdbc

Interface SqlFileRepository

All Known Implementing Classes:

AbstractSqlFileRepository, GreedyCacheSqlFileRepository, NoCacheSqlFileRepository

public interface SqlFileRepository

A repository interface for managing and retrieving SqlFile instances.

This repository is responsible for locating and loading SQL files that correspond to DAO methods. The path to a SQL file is built from the fully qualified name of the DAO interface and the method name. For example, when org.example.ExampleDao interface has a selectAll method, the corresponding SQL file path is META-INF/org/example/ExampleDao/selectAll.sql.

The implementation class must be thread safe.

See Also:

• Config.getSqlFileRepository()

Method Summary

Modifier and Type	Method	Description
default void	clearCache()	Clears cache.
SqlFile	getSqlFile(Method method, String path, Dialect dialect)	Returns the SQL file.

Method Details

getSqlFile

SqlFile getSqlFile(Method method,
 String path,
 Dialect dialect)

Returns the SQL file.

Parameters:

method - the DAO method

path - the SQL file path

dialect - the SQL dialect

Returns:

the SQL file

Throws:

DomaNullPointerException - if any arguments are null

DomaIllegalArgumentException - if the method is not annotated with Sql and the path does not match the Ant-style glob pattern "META-INF/**/*.sql"

SqlFileNotFoundException - if the SQL file is not found

JdbcException - if an error other than listed above occurs

clearCache

default void clearCache()

Clears cache.