pl.jsolve.templ4docx.core

Class Docx

java.lang.Object

pl.jsolve.templ4docx.core.Docx

All Implemented Interfaces:

Serializable

public class Docx
extends Object
implements Serializable

The main class responsible for reading docx template, finding variables, saving completed docx template

Author:

Lukasz Stypka

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Docx(InputStream docxInputStream)
Docx(String docxPath)

Method Summary

Modifier and Type	Method and Description
void	fillTemplate(Variables variables) Method replaces found variable to value provided by user
List<String>	findVariables() Finds list of variables in the template file which satisfy the variable pattern
org.apache.poi.xwpf.usermodel.XWPFDocument	getXWPFDocument() Returns opened XWPFDocument
String	readTextContent() Returns text content as String
void	save(OutputStream outputStream) Save filled template as new .docx file
void	save(String outputPath) Save filled template as new .docx file
void	setVariablePattern(VariablePattern variablePattern) Set variable pattern which indicates how the variable looks like

Methods inherited from class java.lang.Object

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

Constructor Detail

Docx

public Docx(String docxPath)

Docx

public Docx(InputStream docxInputStream)

Method Detail

findVariables

public List<String> findVariables()

Finds list of variables in the template file which satisfy the variable pattern

Returns:

list of found variables

readTextContent

public String readTextContent()

Returns text content as String

Returns:

String text content of template file

fillTemplate

public void fillTemplate(Variables variables)

Method replaces found variable to value provided by user

Parameters:

variables - Variables

save

public void save(String outputPath)

Save filled template as new .docx file

Parameters:

outputPath - String

save

public void save(OutputStream outputStream)

Save filled template as new .docx file

Parameters:

outputStream - OutputStream

setVariablePattern

public void setVariablePattern(VariablePattern variablePattern)

Set variable pattern which indicates how the variable looks like

Parameters:

variablePattern - VariablePattern

getXWPFDocument

public org.apache.poi.xwpf.usermodel.XWPFDocument getXWPFDocument()

Returns opened XWPFDocument

Returns:

XWPFDocument