SqlTemplateUtil (msyy-java 1.0.2 API)

java.lang.Object
- io.github.msyysoft.java.database.SqlTemplateUtil

```
public class SqlTemplateUtil
extends Object
```
Title: 用来处理类路径下sqltemplate中的SQL XML配置文件
Description: 加载SQL配置文件，并解析。用来获取SQL的工具。程序员不需要使用，组件开发人员可以使用。
Date: 2018-01-04
Copyright (c) 2018 dyfc

字段概要

字段
限定符和类型	字段和说明
`private freemarker.template.Configuration`	`cfg`
`private org.slf4j.Logger`	`log`
`protected static org.slf4j.Logger`	`logger`
`private static SqlTemplateUtil`	`ourInstance`
`private List<String>`	`repeatSqlkeyList`
`private HashMap<String,String>`	`sqlMap`
`private String`	`sqlTemplateDir`
`private freemarker.cache.StringTemplateLoader`	`sTmpLoader`

构造器概要

构造器
限定符构造器和说明

private SqlTemplateUtil()

构造器
限定符	构造器和说明
`private`	`SqlTemplateUtil()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Set<String>`	`getAllSqlKey()`
`static SqlTemplateUtil`	`getInstance()`
`String`	`getPageSqlString(String sqlKey, int pagesize, int pagenum)` 根据SQL配置文件中的索引key值，取到配置文件中的SQL语句的分页查询语句
`String`	`getPageSqlString(String sqlKey, int pagesize, int pagenum, Map<String,Object> paramMap)` 根据SQL配置文件中的索引key值，取到配置文件中的SQL语句的分页查询语句并将SQL语句中Freemarker中的名称占位符用map中的数据替换掉。
`String`	`getRecordNumberSqlString(String sqlKey)` 根据SQL配置文件中的索引key值，取到配置文件中的SQL语句的查询总条数的SQL语句
`String`	`getRecordNumberSqlString(String sqlKey, Map<String,Object> paramMap)` 根据SQL配置文件中的索引key值，取到配置文件中的SQL语句的查询总条数的SQL语句并将SQL语句中的Freemarker占位符用Map中的数据替换掉
`String`	`getSqlString(String sqlKey)` 根据SQL配置文件中的索引key值，取到配置文件中的SQL语句字符串
`String`	`getSqlString(String sqlKey, Map<String,Object> paramMap)` 根据SQL配置文件中的索引key值，取到配置文件中的SQL语句字符串并将SQL语句中Freemarker中的名称占位符用map中的数据替换掉。
`private void`	`init()` 初始化方法，syscontext组件中的程序会调用该方法完成对SQL配置文件的记载。
`private void`	`realinit(org.springframework.core.io.Resource rc)` 加载类路径sqltemplate文件夹中所有XML文件，并用jdom解析配置文件
`boolean`	`setSqlTemplateDir(String sqlTemplateDir)` 在未实例化之前可以设置 sqlTemplateDir

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

- 字段详细资料
  - ourInstance
```
private static SqlTemplateUtil ourInstance
```
  - logger
```
protected static final org.slf4j.Logger logger
```
  - sqlTemplateDir
```
private String sqlTemplateDir
```
  - log
```
private org.slf4j.Logger log
```
  - sqlMap
```
private HashMap<String,String> sqlMap
```
  - cfg
```
private freemarker.template.Configuration cfg
```
  - sTmpLoader
```
private freemarker.cache.StringTemplateLoader sTmpLoader
```
  - repeatSqlkeyList
```
private List<String> repeatSqlkeyList
```
- 构造器详细资料
  - SqlTemplateUtil
```
private SqlTemplateUtil()
```
- 方法详细资料
  - getInstance
```
public static SqlTemplateUtil getInstance()
```
  - setSqlTemplateDir
```
public boolean setSqlTemplateDir(String sqlTemplateDir)
```
    在未实例化之前可以设置 sqlTemplateDir
    
    参数:
    
    sqlTemplateDir -
    
    返回:
  - init
```
private void init()
           throws IOException,
                  org.dom4j.DocumentException
```
    初始化方法，syscontext组件中的程序会调用该方法完成对SQL配置文件的记载。调用该方法的时候static块被执行
    
    抛出:
    
    IOException
    
    org.dom4j.DocumentException
  - realinit
```
private void realinit(org.springframework.core.io.Resource rc)
               throws IOException,
                      org.dom4j.DocumentException
```
    加载类路径sqltemplate文件夹中所有XML文件，并用jdom解析配置文件
    
    抛出:
    
    IOException
    
    org.dom4j.DocumentException
  - getAllSqlKey
```
public Set<String> getAllSqlKey()
```
  - getSqlString
```
public String getSqlString(String sqlKey)
```
    根据SQL配置文件中的索引key值，取到配置文件中的SQL语句字符串
    
    参数:
    
    sqlKey，SQL - XML配置文件中的索引key值
    
    返回:
    
    String 返回索引key值对应的SQL语句字符串
  - getSqlString
```
public String getSqlString(String sqlKey,
                           Map<String,Object> paramMap)
```
    根据SQL配置文件中的索引key值，取到配置文件中的SQL语句字符串并将SQL语句中Freemarker中的名称占位符用map中的数据替换掉。
    
    参数:
    
    sqlKey，SQL-XML配置文件中的索引key值 -
    
    paramMap，Freemarker中名称占位符为key，需要替换的数据位value装入map，通过该Map进行替换 -
    
    返回:
    
    String 返回索引key值对应的SQL语句字符串，并替换SQL语句中Freemarker名称占位符
  - getPageSqlString
```
public String getPageSqlString(String sqlKey,
                               int pagesize,
                               int pagenum)
```
    根据SQL配置文件中的索引key值，取到配置文件中的SQL语句的分页查询语句
    
    参数:
    
    sqlKey，SQL-XML配置文件中的索引key值 -
    
    pagesize，每一页显示数据的条数 -
    
    pagenum，查询哪一页的数据 -
    
    返回:
    
    String 返回索引key值对应的SQL语句的分页查询语句
  - getPageSqlString
```
public String getPageSqlString(String sqlKey,
                               int pagesize,
                               int pagenum,
                               Map<String,Object> paramMap)
```
    根据SQL配置文件中的索引key值，取到配置文件中的SQL语句的分页查询语句并将SQL语句中Freemarker中的名称占位符用map中的数据替换掉。
    
    参数:
    
    sqlKey，SQL-XML配置文件中的索引key值 -
    
    pagesize，每一页显示数据的条数 -
    
    pagenum，查询哪一页的数据 -
    
    paramMap，Freemarker中名称占位符为key，需要替换的数据位value装入map，通过该Map进行替换 -
    
    返回:
    
    String 返回索引key值对应的SQL语句的分页查询语句，并替换SQL语句中Freemarker名称占位符
  - getRecordNumberSqlString
```
public String getRecordNumberSqlString(String sqlKey)
```
    根据SQL配置文件中的索引key值，取到配置文件中的SQL语句的查询总条数的SQL语句
    
    参数:
    
    sqlKey，SQL - XML配置文件中的索引key值
    
    返回:
    
    String 返回索引key值对应的SQL语句的查询总条数SQL语句
  - getRecordNumberSqlString
```
public String getRecordNumberSqlString(String sqlKey,
                                       Map<String,Object> paramMap)
```
    根据SQL配置文件中的索引key值，取到配置文件中的SQL语句的查询总条数的SQL语句并将SQL语句中的Freemarker占位符用Map中的数据替换掉
    
    参数:
    
    sqlKey，SQL-XML配置文件中的索引key值 -
    
    paramMap，Freemarker中名称占位符为key，需要替换的数据位value装入map，通过该Map进行替换 -
    
    返回:
    
    String 返回索引key值对应的SQL语句的查询总条数SQL语句，并替换SQL语句中Freemarker名称占位符

类 SqlTemplateUtil

字段概要

构造器概要

方法概要

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

字段详细资料

ourInstance

logger

sqlTemplateDir

log

sqlMap

cfg

sTmpLoader

repeatSqlkeyList

构造器详细资料

SqlTemplateUtil

方法详细资料

getInstance

setSqlTemplateDir

init

realinit

getAllSqlKey

getSqlString

getSqlString

getPageSqlString

getPageSqlString

getRecordNumberSqlString

getRecordNumberSqlString