PathLoader (sql-core 3.30.0-RELEASE API)

java.lang.Object
- org.beetl.sql.core.loader.AbstractSQLLoader
- - org.beetl.sql.core.loader.PathLoader

所有已实现的接口:

SQLLoader

直接已知子类:

AbsolutePathLoader, MarkdownClasspathLoader
```
public abstract class PathLoader
extends AbstractSQLLoader
```
从classpath系统加载sql模板，id应该格式是"xx.yyy",xx代表了文件名，yyy代表了sql标识 sql 模板格式如下：
```
 selectUser
 ===

 select * from user
 
```
可以重载此类，实现#getParser 用于解析其他格式文件，比如xml格式的sql文件
作者:

Administrator

字段概要

字段
限定符和类型字段和说明

protected String charset

protected SQLSource EMPTY
外部sql缓存

protected String sqlRoot
- 从类继承的字段 org.beetl.sql.core.loader.AbstractSQLLoader
  autoGenSourceMap, dbs, product, sqlSourceMap

字段
限定符和类型	字段和说明
`protected String`	`charset`
`protected SQLSource`	`EMPTY` 外部sql缓存
`protected String`	`sqlRoot`

构造器概要

构造器
构造器和说明

PathLoader()

PathLoader(String root)

PathLoader(String root, String charset)

构造器
构造器和说明
`PathLoader()`
`PathLoader(String root)`
`PathLoader(String root, String charset)`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected BufferedReader`	`buildBufferedReader(InputStream inputStream, String charset)` 子类覆盖，可以用于加密文件的解密
`boolean`	`existExternalSource(SqlId id)`
`boolean`	`existNamespace(SqlId id)` 检测是否存在sqlId的namespace，如文件
`String`	`getCharset()`
`protected URL`	`getDBRootFile(SqlId id)`
`protected abstract URL`	`getFile(String filePath)`
`protected URL`	`getFilePath(String root, SqlId id)`
`protected abstract SQLFileParser`	`getParser(String modelName, BufferedReader br)`
`protected URL`	`getRootFile(SqlId id)` 获取.md文件 md文件需放在classpath下
`String`	`getSqlRoot()`
`protected Long`	`getURLVersion(URL url)`
`protected boolean`	`isExternalSourceModified4Load(SqlId id)`
`protected void`	`loadFromClassPath(SqlId id)` 考虑到跨数据库支持，ClasspathLoader加载SQL顺序如下：首先根据DBStyle.getName() 找到对应的数据库名称，然后在ROOT/dbName 下找对应的sql，如果ROOT/dbName 文件目录不存在，或者相应的sql文件不存在，再搜索ROOT目录下的sql文件。
`SQLSource`	`loadSQL(SqlId id)` 同querySQL，但总是加载新的sql
`SQLSource`	`queryExternalSource(SqlId id)`
`protected SQLSource`	`queryFromCache(SqlId sqlId)`
`protected void`	`readSqlFile(SqlId sqlId, URL url, boolean isRoot)`
`void`	`refresh()`
`void`	`setCharset(String charset)`
`void`	`setSqlRoot(String sqlRoot)`
`String`	`toString()`

从类继承的方法 org.beetl.sql.core.loader.AbstractSQLLoader
addAutoGenSQL, addSQL, exist, getDbStyle, getException, getPathBySqlId, isProduct, queryAutoSQL, querySQL, setDbStyle, setProduct

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - sqlRoot
```
protected String sqlRoot
```
  - charset
```
protected String charset
```
  - EMPTY
```
protected SQLSource EMPTY
```
    外部sql缓存
- 构造器详细资料
  - PathLoader
```
public PathLoader(String root,
                  String charset)
```
  - PathLoader
```
public PathLoader(String root)
```
  - PathLoader
```
public PathLoader()
```
- 方法详细资料
  - loadSQL
```
public SQLSource loadSQL(SqlId id)
```
    从接口复制的说明: SQLLoader
    
    同querySQL，但总是加载新的sql
    
    返回:
  - queryExternalSource
```
public SQLSource queryExternalSource(SqlId id)
```
    指定者:
    
    queryExternalSource 在类中 AbstractSQLLoader
  - queryFromCache
```
protected SQLSource queryFromCache(SqlId sqlId)
```
  - isExternalSourceModified4Load
```
protected boolean isExternalSourceModified4Load(SqlId id)
```
  - existExternalSource
```
public boolean existExternalSource(SqlId id)
```
    指定者:
    
    existExternalSource 在类中 AbstractSQLLoader
  - getURLVersion
```
protected Long getURLVersion(URL url)
```
  - loadFromClassPath
```
protected void loadFromClassPath(SqlId id)
```
    考虑到跨数据库支持，ClasspathLoader加载SQL顺序如下：首先根据DBStyle.getName() 找到对应的数据库名称，然后在ROOT/dbName 下找对应的sql，如果ROOT/dbName 文件目录不存在，或者相应的sql文件不存在，再搜索ROOT目录下的sql文件。如mysql 里查找user.select2,顺序如下： - 先找ROOT/mysql/user.sql 文件，如果有此文件，且包含了select2，则返回此sql语句， - 如果没有，下一步查找ROOT/mysql/user.md,如果有此文件，且包含了slect2，则返回sql语句 - 如果没有，下一步查找ROOT/user.sql,如果有此文件，且包含了slect2，则返回sql语句 - 如果没有，下一步查找ROOT/user.md,如果有此文件，且包含了slect2，则返回sql语句 - 都没有，抛错，告诉用户未在ROOT/,或者ROOT/mysql 下找到相关sql
  - readSqlFile
```
protected void readSqlFile(SqlId sqlId,
                           URL url,
                           boolean isRoot)
```
  - getRootFile
```
protected URL getRootFile(SqlId id)
```
    获取.md文件 md文件需放在classpath下
    
    参数:
    
    id -
    
    返回:
  - getDBRootFile
```
protected URL getDBRootFile(SqlId id)
```
  - getFilePath
```
protected URL getFilePath(String root,
                          SqlId id)
```
  - getFile
```
protected abstract URL getFile(String filePath)
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - existNamespace
```
public boolean existNamespace(SqlId id)
```
    从接口复制的说明: SQLLoader
    
    检测是否存在sqlId的namespace，如文件
    
    返回:
  - getParser
```
protected abstract SQLFileParser getParser(String modelName,
                                           BufferedReader br)
                                    throws IOException
```
    抛出:
    
    IOException
  - buildBufferedReader
```
protected BufferedReader buildBufferedReader(InputStream inputStream,
                                             String charset)
```
    子类覆盖，可以用于加密文件的解密
    
    参数:
    
    inputStream -
    
    charset -
    
    返回:
  - getSqlRoot
```
public String getSqlRoot()
```
  - setSqlRoot
```
public void setSqlRoot(String sqlRoot)
```
  - getCharset
```
public String getCharset()
```
  - setCharset
```
public void setCharset(String charset)
```
  - refresh
```
public void refresh()
```
    指定者:
    
    refresh 在接口中 SQLLoader
    
    覆盖:
    
    refresh 在类中 AbstractSQLLoader

类 PathLoader

字段概要

从类继承的字段 org.beetl.sql.core.loader.AbstractSQLLoader

构造器概要

方法概要

从类继承的方法 org.beetl.sql.core.loader.AbstractSQLLoader

从类继承的方法 java.lang.Object

字段详细资料

sqlRoot

charset

EMPTY

构造器详细资料

PathLoader

PathLoader

PathLoader

方法详细资料

loadSQL

queryExternalSource

queryFromCache

isExternalSourceModified4Load

existExternalSource

getURLVersion

loadFromClassPath

readSqlFile

getRootFile

getDBRootFile

getFilePath

getFile

toString

existNamespace

getParser

buildBufferedReader

getSqlRoot

setSqlRoot

getCharset

setCharset

refresh