Module org.seasar.doma.core

Package org.seasar.doma.jdbc

Class AbstractSqlFileRepository

java.lang.Object

org.seasar.doma.jdbc.AbstractSqlFileRepository

All Implemented Interfaces:

SqlFileRepository

Direct Known Subclasses:

GreedyCacheSqlFileRepository, NoCacheSqlFileRepository

public abstract class AbstractSqlFileRepository
extends Object
implements SqlFileRepository

A skeletal implementation of the SqlFileRepository interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	AbstractSqlFileRepository.CacheKey

Constructor Summary

Constructors

Constructor	Description
AbstractSqlFileRepository()

Method Summary

Modifier and Type	Method	Description
protected final SqlFile	createSqlFile(Method method, String path, Dialect dialect)	Creates the SQL file.
protected final String	getPrimaryPath(String path, Dialect dialect)	Returns the primary path to find SQL file for specific RDBMS.
protected String	getSql(String path)	Retrieves the SQL string from the SQL file.
final SqlFile	getSqlFile(Method method, String path, Dialect dialect)	Returns the SQL file.
protected abstract SqlFile	getSqlFileWithCacheControl(Method method, String path, Dialect dialect)	Returns the SQL file in consideration of cache control.
protected final SqlNode	parse(String sql)	Parses the SQL string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.seasar.doma.jdbc.SqlFileRepository

clearCache

Constructor Details

AbstractSqlFileRepository

public AbstractSqlFileRepository()

Method Details

getSqlFile

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

Description copied from interface: SqlFileRepository

Returns the SQL file.

Specified by:

getSqlFile in interface SqlFileRepository

Parameters:

method - the DAO method

path - the SQL file path

dialect - the SQL dialect

Returns:

the SQL file

getSqlFileWithCacheControl

protected abstract SqlFile getSqlFileWithCacheControl(Method method,
 String path,
 Dialect dialect)

Returns the SQL file in consideration of cache control.

Parameters:

method - the Dao method

path - the SQL file path

dialect - the dialect

Returns:

the SQL file

Throws:

SqlFileNotFoundException - if the SQL file is not found

JdbcException - if an error occurs

createSqlFile

protected final SqlFile createSqlFile(Method method,
 String path,
 Dialect dialect)

Creates the SQL file.

Parameters:

method - the Dao method

path - the SQL file path

dialect - the dialect

Returns:

the SQL file

getPrimaryPath

protected final String getPrimaryPath(String path,
 Dialect dialect)

Returns the primary path to find SQL file for specific RDBMS.

Parameters:

path - the SQL file path

dialect - the dialect

Returns:

the primary path

parse

protected final SqlNode parse(String sql)

Parses the SQL string.

Parameters:

sql - the SQL string

Returns:

the SQL node

getSql

protected String getSql(String path)

Retrieves the SQL string from the SQL file.

Parameters:

path - the SQL file path

Returns:

the SQL string