io.mybatis.rui.template

Class Project

java.lang.Object

io.mybatis.rui.template.Ref<Structure>

io.mybatis.rui.template.struct.Structure

io.mybatis.rui.template.Project

public class Project
extends Structure

顶层项目

Field Summary

Fields

Modifier and Type	Field and Description
protected String	path 项目根路径

Fields inherited from class io.mybatis.rui.template.struct.Structure

attrs, enabled, file, files, filter, id, iter, iterName, itFilter, mode, name, parent, times, type

Constructor Summary

Constructors

Constructor and Description
Project()

Method Summary

Modifier and Type	Method and Description
void	addDataSource(String name, Object dataSource) 添加数据源
void	generate() 生成代码
void	generate(File template) 使用指定的模板进行生成（仍然是 project.yaml 中配置的模板）
void	generate(File template, Map<String,?> params) 使用指定的模板进行生成（仍然是 project.yaml 中配置的模板）
void	generate(Map<String,?> params) 生成代码
void	generate(VFS template) 使用指定的模板进行生成（仍然是 project.yaml 中配置的模板）
void	generate(VFS template, Map<String,?> params) 使用指定的模板进行生成（仍然是 project.yaml 中配置的模板）
Database	getDatabase()
void	initParams(Context context, Map<String,Object> params) 初始化参数，需要在具体语境中初始化
protected void	initPath(Map<String,Object> params) 处理模板路径，当使用可执行 jar 包运行时，资源文件可以在任何位置，也可能用到绝对路径
static Project	load(@NonNull InputStream inputStream) 从资源文件流加载
static Project	load(@NonNull String resource) 从资源文件加载
VFS	preview() 预览代码，返回虚拟文件结构
VFS	preview(Map<String,?> params) 预览代码，返回虚拟文件结构
VFS	preview(VFS template) 预览代码，返回虚拟文件结构
VFS	preview(VFS template, Map<String,?> params) 预览代码，返回虚拟文件结构

Methods inherited from class io.mybatis.rui.template.struct.Structure

addFiles, autoStruct, generator, getAttr, getAttr, getAttr, getFiles, setFiles, toString

Methods inherited from class io.mybatis.rui.template.Ref

getR, getRef, load, load, setRef

Methods inherited from class java.lang.Object

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

Field Detail

path

protected String path

项目根路径

Constructor Detail

Project

public Project()

Method Detail

load

public static Project load(@NonNull
                           @NonNull String resource)

从资源文件加载

Parameters:

resource -

Returns:

load

public static Project load(@NonNull
                           @NonNull InputStream inputStream)

从资源文件流加载

Parameters:

inputStream -

Returns:

initParams

public void initParams(Context context,
                       Map<String,Object> params)

Description copied from class: Structure

初始化参数，需要在具体语境中初始化

Overrides:

initParams in class Structure

initPath

protected void initPath(Map<String,Object> params)

处理模板路径，当使用可执行 jar 包运行时，资源文件可以在任何位置，也可能用到绝对路径

Parameters:

params -

generate

public void generate()

生成代码

generate

public void generate(Map<String,?> params)

生成代码

Parameters:

params - 指定参数，模板中可以直接 key.attr 使用

generate

public void generate(File template)

使用指定的模板进行生成（仍然是 project.yaml 中配置的模板）

Parameters:

template - 指定模板目录或者模板压缩文件

generate

public void generate(VFS template)

使用指定的模板进行生成（仍然是 project.yaml 中配置的模板）

Parameters:

template - 模板虚拟目录

generate

public void generate(File template,
                     Map<String,?> params)

使用指定的模板进行生成（仍然是 project.yaml 中配置的模板）

Parameters:

template - 指定模板目录或者模板压缩文件

params - 指定参数，模板中可以直接 key.attr 使用

generate

public void generate(VFS template,
                     Map<String,?> params)

使用指定的模板进行生成（仍然是 project.yaml 中配置的模板）

Parameters:

template - 模板虚拟目录

params - 指定参数，模板中可以直接 key.attr 使用

preview

public VFS preview()

预览代码，返回虚拟文件结构

Returns:

虚拟文件结构

preview

public VFS preview(Map<String,?> params)

预览代码，返回虚拟文件结构

Parameters:

params - 指定参数，模板中可以直接 key.attr 使用

Returns:

虚拟文件结构

preview

public VFS preview(VFS template)

预览代码，返回虚拟文件结构

Parameters:

template - 模板虚拟目录

Returns:

虚拟文件结构

preview

public VFS preview(VFS template,
                   Map<String,?> params)

预览代码，返回虚拟文件结构

Parameters:

template - 模板虚拟目录

params - 指定参数，模板中可以直接 key.attr 使用

Returns:

虚拟文件结构

addDataSource

public void addDataSource(String name,
                          Object dataSource)

添加数据源

Parameters:

name -

dataSource -

getDatabase

public Database getDatabase()