com.relaxed.poi

类 PoiTemplate

java.lang.Object

com.relaxed.poi.PoiTemplate

public class PoiTemplate
extends Object

Main template class for POI-TL that handles Word document rendering and template processing. This class provides methods for rendering Word documents with various data sources and configurations.

从以下版本开始:

1.0

作者:

Yakir

字段概要

字段

限定符和类型	字段和说明
static PoiTemplate	INSTANCE Singleton instance of PoiTemplate.

方法概要

限定符和类型	方法和说明
protected List<ElementMeta>	convertToElementMetas(List<com.deepoove.poi.template.MetaTemplate> elementTemplates) Converts element templates to element metadata, removing duplicates.
<R> R	render(InputStream inputStream, com.deepoove.poi.config.Configure configure, RenderFunction<R> function) Renders the template using the provided render function.
void	renderWord(File source, File dest, List<LabelData> contents) Renders a Word document from source file to destination file using label data.
void	renderWord(File source, File dest, List<LabelData> contents, com.deepoove.poi.config.Configure configure) Renders a Word document from source file to destination file using label data and custom configuration.
void	renderWord(File source, File dest, Map<String,Object> data) Renders a Word document from source file to destination file using data map.
void	renderWord(File source, File dest, Map<String,Object> data, com.deepoove.poi.config.Configure configure) Renders a Word document from source file to destination file using data map and custom configuration.
void	renderWord(InputStream inputStream, OutputStream outputStream, List<LabelData> contents) Renders a Word document from input stream to output stream using label data.
void	renderWord(InputStream inputStream, OutputStream outputStream, List<LabelData> contents, com.deepoove.poi.config.Configure configure) Renders a Word document from input stream to output stream using label data and custom configuration.
void	renderWord(InputStream inputStream, OutputStream outputStream, Map<String,Object> dataMap) Renders a Word document from input stream to output stream using data map.
void	renderWord(InputStream inputStream, OutputStream outputStream, Map<String,Object> dataMap, com.deepoove.poi.config.Configure configure) Renders a Word document from input stream to output stream using data map and custom configuration.
List<ElementMeta>	templateElement(InputStream inputStream) Extracts template elements from the input stream using default configuration.
List<ElementMeta>	templateElement(InputStream inputStream, com.deepoove.poi.config.Configure configure) Extracts template elements from the input stream using custom configuration.

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

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

字段详细资料

INSTANCE

public static final PoiTemplate INSTANCE

Singleton instance of PoiTemplate.

方法详细资料

renderWord

public void renderWord(File source,
                       File dest,
                       List<LabelData> contents)

Renders a Word document from source file to destination file using label data.

参数:

source - the source Word template file

dest - the destination file to write the rendered document

contents - the list of label data to render

renderWord

public void renderWord(File source,
                       File dest,
                       List<LabelData> contents,
                       com.deepoove.poi.config.Configure configure)

Renders a Word document from source file to destination file using label data and custom configuration.

参数:

source - the source Word template file

dest - the destination file to write the rendered document

contents - the list of label data to render

configure - the custom configuration to use

renderWord

public void renderWord(File source,
                       File dest,
                       Map<String,Object> data)

Renders a Word document from source file to destination file using data map.

参数:

source - the source Word template file

dest - the destination file to write the rendered document

data - the data map containing template variables

renderWord

public void renderWord(File source,
                       File dest,
                       Map<String,Object> data,
                       com.deepoove.poi.config.Configure configure)

Renders a Word document from source file to destination file using data map and custom configuration.

参数:

source - the source Word template file

dest - the destination file to write the rendered document

data - the data map containing template variables

configure - the custom configuration to use

renderWord

public void renderWord(InputStream inputStream,
                       OutputStream outputStream,
                       List<LabelData> contents)

Renders a Word document from input stream to output stream using label data.

参数:

inputStream - the input stream containing the Word template

outputStream - the output stream to write the rendered document

contents - the list of label data to render

renderWord

public void renderWord(InputStream inputStream,
                       OutputStream outputStream,
                       List<LabelData> contents,
                       com.deepoove.poi.config.Configure configure)

Renders a Word document from input stream to output stream using label data and custom configuration.

参数:

inputStream - the input stream containing the Word template

outputStream - the output stream to write the rendered document

contents - the list of label data to render

configure - the custom configuration to use

renderWord

public void renderWord(InputStream inputStream,
                       OutputStream outputStream,
                       Map<String,Object> dataMap)

Renders a Word document from input stream to output stream using data map.

参数:

inputStream - the input stream containing the Word template

outputStream - the output stream to write the rendered document

dataMap - the data map containing template variables

renderWord

public void renderWord(InputStream inputStream,
                       OutputStream outputStream,
                       Map<String,Object> dataMap,
                       com.deepoove.poi.config.Configure configure)

Renders a Word document from input stream to output stream using data map and custom configuration.

参数:

inputStream - the input stream containing the Word template

outputStream - the output stream to write the rendered document

dataMap - the data map containing template variables

configure - the custom configuration to use

templateElement

public List<ElementMeta> templateElement(InputStream inputStream)

Extracts template elements from the input stream using default configuration.

参数:

inputStream - the input stream containing the Word template

返回:

list of element metadata

templateElement

public List<ElementMeta> templateElement(InputStream inputStream,
                                         com.deepoove.poi.config.Configure configure)

Extracts template elements from the input stream using custom configuration.

参数:

inputStream - the input stream containing the Word template

configure - the custom configuration to use

返回:

list of element metadata

render

public <R> R render(InputStream inputStream,
                    com.deepoove.poi.config.Configure configure,
                    RenderFunction<R> function)

Renders the template using the provided render function.

类型参数:

R - the type of the render result

参数:

inputStream - the input stream containing the Word template

configure - the configuration to use

function - the render function to apply

返回:

the result of the render function

convertToElementMetas

protected List<ElementMeta> convertToElementMetas(List<com.deepoove.poi.template.MetaTemplate> elementTemplates)

Converts element templates to element metadata, removing duplicates.

参数:

elementTemplates - the list of element templates to convert

返回:

list of unique element metadata