RunPrepare (anyline-data 8.7.2-20250212 API)

所有超级接口:

Cloneable

所有已知子接口:

AutoPrepare, TablePrepare, TextPrepare, TextPrepare

所有已知实现类:

AbstractRunPrepare, DefaultAutoPrepare, DefaultTablePrepare, DefaultTextPrepare, DefaultTextPrepare, SimplePrepare, VirtualTablePrepare
```
public interface RunPrepare
extends Cloneable
```

字段概要

字段
限定符和类型	字段和说明
`static String`	`PROCEDURE_INPUT_PARAM_TYPE`
`static String`	`PROCEDURE_INPUT_PARAM_VALUE`
`static String`	`SQL_VAR_BOX_REGEX`
`static String`	`SQL_VAR_PLACEHOLDER_REGEX`
`static String`	`SQL_VAR_PLACEHOLDER_REGEX_EXT`
`static String`	`XML_SQL_ID_STYLE`

方法概要

All Methods Instance Methods Abstract Methods Default Methods
限定符和类型	方法和说明
`RunPrepare`	`addColumn(Column column)`
`RunPrepare`	`addColumn(String columns)` 添加列 CD CD, NM
`RunPrepare`	`addCondition(Compare compare, String column, Object value)` 添加查询条件
`RunPrepare`	`addCondition(Condition condition)`
`RunPrepare`	`addCondition(String column, Object value)`
`RunPrepare`	`addFetchKey(Collection<String> fetchKeys)`
`RunPrepare`	`addFetchKey(String... fetchKeys)`
`RunPrepare`	`addPrimaryKey(Collection<String> primaryKeys)`
`RunPrepare`	`addPrimaryKey(String... primaryKeys)`
`RunPrepare`	`aggregation(AggregationConfig... configs)`
`RunPrepare`	`aggregation(Aggregation aggregation, String column, String result)`
`RunPrepare`	`aggregation(List<AggregationConfig> configs)`
`List<AggregationConfig>`	`aggregations()`
`RunPrepare`	`box(String box)` 利用RunPrepare构造更复杂的SQL
`Run`	`build(DataRuntime runtime)`
`RunPrepare`	`clone()`
`ConfigStore`	`condition()`
`RunPrepare`	`condition(ConfigStore configs)`
`default boolean`	`disposable()` 是否一次性的(执行过程中可修改，否则应该clone一份，避免影响第二闪使用)
`RunPrepare`	`disposable(boolean disposable)`
`RunPrepare`	`excludeColumn(String columns)`
`default void`	`filter(LinkedHashMap<String,Column> metadatas)` 过滤不存在的列
`RunPrepare`	`full(String table, String condition)`
`String`	`getAlias()`
`int`	`getBatch()`
`Catalog`	`getCatalog()`
`String`	`getCatalogName()`
`LinkedHashMap<String,Column>`	`getColumns()`
`ConditionChain`	`getConditionChain()`
`String`	`getDest()`
`String`	`getDistinct()`
`List<String>`	`getExcludes()`
`List<String>`	`getFetchKeys()`
`GroupStore`	`getGroups()`
`String`	`getId()`
`Join`	`getJoin()`
`List<RunPrepare>`	`getJoins()`
`OrderStore`	`getOrders()`
`PageNavi`	`getPageNavi()`
`String`	`getPrimaryKey()`
`List<String>`	`getPrimaryKeys()`
`String`	`getRuntime()`
`Schema`	`getSchema()`
`String`	`getSchemaName()`
`List<Variable>`	`getSQLVariables()`
`Table`	`getTable()`
`String`	`getTableName()`
`String`	`getText()`
`List<RunPrepare>`	`getUnions()`
`int`	`getVersion()`
`RunPrepare`	`group(GroupStore groups)`
`RunPrepare`	`group(String... groups)` 添加分组条件, 在之前的基础上添加新分组条件, 有重复条件则覆盖
`GroupStore`	`groups()`
`boolean`	`hasPrimaryKeys()`
`ConfigStore`	`having()`
`RunPrepare`	`having(ConfigStore having)`
`RunPrepare`	`having(String having)`
`RunPrepare`	`inner(String table, String condition)`
`boolean`	`isMultiple()` 相同ID是否有多个
`boolean`	`isStrict()` 是否严格格式，不能追加未定义的条件
`boolean`	`isUnionAll()`
`RunPrepare`	`join(Join.TYPE type, String table, String condition)`
`RunPrepare`	`join(RunPrepare prepare)`
`default RunPrepare`	`join(RunPrepare prepare, Join.TYPE type, ConfigStore configs)`
`default RunPrepare`	`join(RunPrepare prepare, Join.TYPE type, String... conditions)`
`default RunPrepare`	`join(RunPrepare prepare, Join join)`
`default String`	`json()`
`default String`	`json(boolean empty)`
`RunPrepare`	`left(String table, String condition)`
`default DataRow`	`map()`
`default DataRow`	`map(boolean empty)`
`DataRow`	`map(boolean empty, boolean join)`
`RunPrepare`	`order(Order order)`
`RunPrepare`	`order(OrderStore order)`
`RunPrepare`	`order(String order)` 添加排序条件, 在之前的基础上添加新排序条件, 有重复条件则覆盖
`RunPrepare`	`order(String col, Order.TYPE type)`
`RunPrepare`	`right(String table, String condition)`
`RunPrepare`	`setAlias(String alias)`
`void`	`setBatch(int batch)`
`RunPrepare`	`setCatalog(String catalog)`
`RunPrepare`	`setConditionValue(String condition, String variable, Object value)` 设置查询条件变量值
`RunPrepare`	`setDest(String dest)` 设置查询或操作的目标(表、存储过程、SQL等) 查询全部列 : setDataSource("V_ADMIN") 查询指定列 : setDataSource(ADMIN(CD, ACCOUNT, NAME, REG_TIME)) 查询指定列 : setDataSource(ADMIN(DISTINCT CD, ACCOUNT, NAME, REG_TIME)) 查询指定列 : setDataSource(ADMIN(DISTINCT {NEWID()}, {getDate()}, CD, ACCOUNT, NAME, REG_TIME)) {}中内容按原样拼接到运行时SQL, 其他列将添加[]以避免关键重复根据XML定义SQL : setDataSource("admin.power:S_POWER") admin.power : XML文件路径, 文件目录以.分隔 S_POWER : 自定义SQL的id
`RunPrepare`	`setDest(Table dest)`
`RunPrepare`	`setDistinct(boolean distinct)`
`RunPrepare`	`setExcludeColumns(List<String> excludeColumn)`
`RunPrepare`	`setExcludeColumns(String... columns)`
`RunPrepare`	`setFetchKey(Collection<String> fetchKeys)`
`RunPrepare`	`setFetchKey(String... fetchKeys)`
`RunPrepare`	`setId(String id)`
`default RunPrepare`	`setJoin(Join.TYPE type, ConfigStore configs)`
`default RunPrepare`	`setJoin(Join.TYPE type, String... conditions)`
`RunPrepare`	`setJoin(Join join)`
`RunPrepare`	`setMultiple(boolean multiple)`
`void`	`setOrders(OrderStore orders)`
`void`	`setPageNavi(PageNavi navi)`
`RunPrepare`	`setPrimaryKey(Collection<String> primaryKeys)`
`RunPrepare`	`setPrimaryKey(String... primaryKeys)`
`RunPrepare`	`setQueryColumns(List<String> columns)`
`RunPrepare`	`setQueryColumns(String... columns)`
`RunPrepare`	`setRuntime(String runtime)` 用来标记运行环境key(其中关联了数据源与适配器) 经常在service方法参数前加数据源前缀缀时会用到
`RunPrepare`	`setSchema(String schema)`
`void`	`setStrict(boolean strict)`
`RunPrepare`	`setText(String text)` 设置SQL文本, 从XML中text标签中取出
`RunPrepare`	`setUnionAll(boolean all)`
`RunPrepare`	`union(List<RunPrepare> prepare)`
`RunPrepare`	`union(List<RunPrepare> prepares, boolean all)`
`RunPrepare`	`union(RunPrepare prepare)`
`RunPrepare`	`union(RunPrepare prepare, boolean all)`
`default RunPrepare`	`unionAll(List<RunPrepare> prepare)`
`default RunPrepare`	`unionAll(RunPrepare prepare)`

字段详细资料
- PROCEDURE_INPUT_PARAM_TYPE
```
static final String PROCEDURE_INPUT_PARAM_TYPE
```
  另请参阅:
  
  常量字段值
- PROCEDURE_INPUT_PARAM_VALUE
```
static final String PROCEDURE_INPUT_PARAM_VALUE
```
  另请参阅:
  
  常量字段值
- SQL_VAR_PLACEHOLDER_REGEX_EXT
```
static final String SQL_VAR_PLACEHOLDER_REGEX_EXT
```
  另请参阅:
  
  常量字段值
- SQL_VAR_PLACEHOLDER_REGEX
```
static final String SQL_VAR_PLACEHOLDER_REGEX
```
  另请参阅:
  
  常量字段值
- SQL_VAR_BOX_REGEX
```
static final String SQL_VAR_BOX_REGEX
```
  另请参阅:
  
  常量字段值
- XML_SQL_ID_STYLE
```
static final String XML_SQL_ID_STYLE
```
  另请参阅:
  
  常量字段值

方法详细资料

disposable
```
default boolean disposable()
```
是否一次性的(执行过程中可修改，否则应该clone一份，避免影响第二闪使用)

返回:

boolean

disposable

RunPrepare disposable(boolean disposable)

getId
```
String getId()
```

setId
```
RunPrepare setId(String id)
```

getJoin
```
Join getJoin()
```

setJoin
```
RunPrepare setJoin(Join join)
```

setJoin

default RunPrepare setJoin(Join.TYPE type,
                           ConfigStore configs)

setJoin

default RunPrepare setJoin(Join.TYPE type,
                           String... conditions)

setDest
```
RunPrepare setDest(String dest)
```
设置查询或操作的目标(表、存储过程、SQL等)
查询全部列 : setDataSource("V_ADMIN")
查询指定列 : setDataSource(ADMIN(CD, ACCOUNT, NAME, REG_TIME))
查询指定列 : setDataSource(ADMIN(DISTINCT CD, ACCOUNT, NAME, REG_TIME))
查询指定列 : setDataSource(ADMIN(DISTINCT {NEWID()}, {getDate()}, CD, ACCOUNT, NAME, REG_TIME))
{}中内容按原样拼接到运行时SQL, 其他列将添加[]以避免关键重复

根据XML定义SQL : setDataSource("admin.power:S_POWER")
admin.power : XML文件路径, 文件目录以.分隔
S_POWER : 自定义SQL的id

参数:

dest - 数据源 : 表|视图|自定义SQL.id

返回:

Run 最终执行命令如JDBC环境中的 SQL 与参数值

setDest
```
RunPrepare setDest(Table dest)
```

getDest
```
String getDest()
```

setCatalog
```
RunPrepare setCatalog(String catalog)
```

getCatalog
```
Catalog getCatalog()
```

getCatalogName
```
String getCatalogName()
```

setSchema
```
RunPrepare setSchema(String schema)
```

getSchema
```
Schema getSchema()
```

getSchemaName
```
String getSchemaName()
```

getTable
```
Table getTable()
```

getTableName
```
String getTableName()
```

setRuntime
```
RunPrepare setRuntime(String runtime)
```
用来标记运行环境key(其中关联了数据源与适配器)
经常在service方法参数前加数据源前缀缀时会用到

参数:

runtime - runtime.key

返回:

RunPrepare

getRuntime
```
String getRuntime()
```

order
```
RunPrepare order(String order)
```
添加排序条件, 在之前的基础上添加新排序条件, 有重复条件则覆盖

参数:

order - order

返回:

Run 最终执行命令如JDBC环境中的 SQL 与参数值

order

RunPrepare order(String col,
                 Order.TYPE type)

order
```
RunPrepare order(Order order)
```

order
```
RunPrepare order(OrderStore order)
```

group
```
RunPrepare group(String... groups)
```
添加分组条件, 在之前的基础上添加新分组条件, 有重复条件则覆盖

参数:

groups - groups

返回:

Run 最终执行命令如JDBC环境中的 SQL 与参数值

group
```
RunPrepare group(GroupStore groups)
```

having
```
RunPrepare having(String having)
```

having
```
RunPrepare having(ConfigStore having)
```

setPageNavi
```
void setPageNavi(PageNavi navi)
```

getPageNavi
```
PageNavi getPageNavi()
```

addCondition

RunPrepare addCondition(Compare compare,
                        String column,
                        Object value)

添加查询条件

参数:: column - 列名; value - 值; compare - 比较方式
返回:: Run 最终执行命令如JDBC环境中的 SQL 与参数值

addCondition

RunPrepare addCondition(String column,
                        Object value)

setText
```
RunPrepare setText(String text)
```
设置SQL文本, 从XML中text标签中取出

参数:

text - text

返回:

Run 最终执行命令如JDBC环境中的 SQL 与参数值

setConditionValue

RunPrepare setConditionValue(String condition,
                             String variable,
                             Object value)

设置查询条件变量值

参数:: condition - 条件ID; variable - 变量; value - 值
返回:: Run 最终执行命令如JDBC环境中的 SQL 与参数值

getOrders
```
OrderStore getOrders()
```

getGroups
```
GroupStore getGroups()
```

having
```
ConfigStore having()
```

setOrders
```
void setOrders(OrderStore orders)
```

getVersion
```
int getVersion()
```

getConditionChain
```
ConditionChain getConditionChain()
```

addCondition

RunPrepare addCondition(Condition condition)

getText
```
String getText()
```

getSQLVariables
```
List<Variable> getSQLVariables()
```

addPrimaryKey

RunPrepare addPrimaryKey(String... primaryKeys)

addPrimaryKey

RunPrepare addPrimaryKey(Collection<String> primaryKeys)

setPrimaryKey

RunPrepare setPrimaryKey(String... primaryKeys)

setPrimaryKey

RunPrepare setPrimaryKey(Collection<String> primaryKeys)

getPrimaryKeys
```
List<String> getPrimaryKeys()
```

getPrimaryKey
```
String getPrimaryKey()
```

hasPrimaryKeys
```
boolean hasPrimaryKeys()
```

addFetchKey

RunPrepare addFetchKey(String... fetchKeys)

addFetchKey

RunPrepare addFetchKey(Collection<String> fetchKeys)

setFetchKey

RunPrepare setFetchKey(String... fetchKeys)

setFetchKey

RunPrepare setFetchKey(Collection<String> fetchKeys)

getFetchKeys
```
List<String> getFetchKeys()
```

setQueryColumns

RunPrepare setQueryColumns(String... columns)

setQueryColumns

RunPrepare setQueryColumns(List<String> columns)

getColumns

LinkedHashMap<String,Column> getColumns()

getExcludes
```
List<String> getExcludes()
```

setExcludeColumns

RunPrepare setExcludeColumns(List<String> excludeColumn)

setExcludeColumns

RunPrepare setExcludeColumns(String... columns)

addColumn
```
RunPrepare addColumn(String columns)
```
添加列 CD CD, NM

参数:

columns - columns

addColumn
```
RunPrepare addColumn(Column column)
```

excludeColumn

RunPrepare excludeColumn(String columns)

join

RunPrepare join(Join.TYPE type,
                String table,
                String condition)

inner

RunPrepare inner(String table,
                 String condition)

left

RunPrepare left(String table,
                String condition)

right

RunPrepare right(String table,
                 String condition)

full

RunPrepare full(String table,
                String condition)

setAlias
```
RunPrepare setAlias(String alias)
```

getAlias
```
String getAlias()
```

isMultiple
```
boolean isMultiple()
```
相同ID是否有多个

返回:

boolean

setMultiple

RunPrepare setMultiple(boolean multiple)

isStrict
```
boolean isStrict()
```
是否严格格式，不能追加未定义的条件

返回:

boolean

setStrict
```
void setStrict(boolean strict)
```

setBatch
```
void setBatch(int batch)
```

getBatch
```
int getBatch()
```

condition
```
ConfigStore condition()
```

condition

RunPrepare condition(ConfigStore configs)

setUnionAll
```
RunPrepare setUnionAll(boolean all)
```

isUnionAll
```
boolean isUnionAll()
```

union

RunPrepare union(RunPrepare prepare,
                 boolean all)

union
```
RunPrepare union(RunPrepare prepare)
```

unionAll

default RunPrepare unionAll(RunPrepare prepare)

union

RunPrepare union(List<RunPrepare> prepares,
                 boolean all)

union

RunPrepare union(List<RunPrepare> prepare)

unionAll

default RunPrepare unionAll(List<RunPrepare> prepare)

getUnions
```
List<RunPrepare> getUnions()
```

getJoins
```
List<RunPrepare> getJoins()
```

join
```
RunPrepare join(RunPrepare prepare)
```

join

default RunPrepare join(RunPrepare prepare,
                        Join join)

join

default RunPrepare join(RunPrepare prepare,
                        Join.TYPE type,
                        ConfigStore configs)

join

default RunPrepare join(RunPrepare prepare,
                        Join.TYPE type,
                        String... conditions)

filter

default void filter(LinkedHashMap<String,Column> metadatas)

过滤不存在的列

参数:: metadatas - 可用范围

getDistinct
```
String getDistinct()
```

setDistinct

RunPrepare setDistinct(boolean distinct)

build
```
Run build(DataRuntime runtime)
```

map

DataRow map(boolean empty,
            boolean join)

map
```
default DataRow map(boolean empty)
```

map
```
default DataRow map()
```

json
```
default String json(boolean empty)
```

json
```
default String json()
```

groups
```
GroupStore groups()
```

aggregation

RunPrepare aggregation(Aggregation aggregation,
                       String column,
                       String result)

aggregation

RunPrepare aggregation(AggregationConfig... configs)

aggregation

RunPrepare aggregation(List<AggregationConfig> configs)

aggregations
```
List<AggregationConfig> aggregations()
```

box
```
RunPrepare box(String box)
```
利用RunPrepare构造更复杂的SQL

参数:

box - CREATE VIEW AS ${body} 其中${body}会替换成this.sql

返回:

this

clone
```
RunPrepare clone()
```

接口 RunPrepare

字段概要

方法概要

字段详细资料

PROCEDURE_INPUT_PARAM_TYPE

PROCEDURE_INPUT_PARAM_VALUE

SQL_VAR_PLACEHOLDER_REGEX_EXT

SQL_VAR_PLACEHOLDER_REGEX

SQL_VAR_BOX_REGEX

XML_SQL_ID_STYLE

方法详细资料

disposable

disposable

getId

setId

getJoin

setJoin

setJoin

setJoin

setDest

setDest

getDest

setCatalog

getCatalog

getCatalogName

setSchema

getSchema

getSchemaName

getTable

getTableName

setRuntime

getRuntime

order

order

order

order

group

group

having

having

setPageNavi

getPageNavi

addCondition

addCondition

setText

setConditionValue

getOrders

getGroups

having

setOrders

getVersion

getConditionChain

addCondition

getText

getSQLVariables

addPrimaryKey

addPrimaryKey

setPrimaryKey

setPrimaryKey

getPrimaryKeys

getPrimaryKey

hasPrimaryKeys

addFetchKey

addFetchKey

setFetchKey

setFetchKey

getFetchKeys

setQueryColumns

setQueryColumns

getColumns

getExcludes

setExcludeColumns

setExcludeColumns

addColumn

addColumn

excludeColumn

join

inner

left

right