A B C D E F G I K M O P R S T U V

A

add(ParagraphInsert) - Method in class pl.jsolve.templ4docx.cleaner.ParagraphCleaner

Add new paragraph which should be removed from document

add(XWPFTableRow) - Method in class pl.jsolve.templ4docx.cleaner.TableRowCleaner

Add table row which should be removed from the table

add(TableCellInsert) - Method in class pl.jsolve.templ4docx.insert.TableRowInsert

addBulletListVariable(BulletListVariable) - Method in class pl.jsolve.templ4docx.variable.Variables

addBulletListVariables(String, List<BulletListVariable>) - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

addBulletListVariables(String, BulletListVariable...) - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

addImageVariable(ImageVariable) - Method in class pl.jsolve.templ4docx.variable.Variables

addImageVariables(String, List<ImageVariable>) - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

addImageVariables(String, ImageVariable...) - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

addSubKey(Key) - Method in class pl.jsolve.templ4docx.util.Key

addTableVariable(TableVariable) - Method in class pl.jsolve.templ4docx.variable.Variables

addTextVariable(TextVariable) - Method in class pl.jsolve.templ4docx.variable.Variables

addTextVariables(String, List<String>) - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

addTextVariables(String, String...) - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

addVariable(List<? extends Variable>) - Method in class pl.jsolve.templ4docx.variable.TableVariable

B

BulletListInsert - Class in pl.jsolve.templ4docx.insert

Insert for bullet list.

BulletListInsert(Key, XWPFParagraph, XWPFTableCell, XWPFDocument) - Constructor for class pl.jsolve.templ4docx.insert.BulletListInsert

BulletListInsertStrategy - Class in pl.jsolve.templ4docx.strategy

BulletListInsertStrategy(InsertStrategyChooser, ParagraphCleaner) - Constructor for class pl.jsolve.templ4docx.strategy.BulletListInsertStrategy

BulletListVariable - Class in pl.jsolve.templ4docx.variable

BulletListVariable(String, List<? extends Variable>) - Constructor for class pl.jsolve.templ4docx.variable.BulletListVariable

C

clean(Docx, Variables, VariablePattern) - Method in class pl.jsolve.templ4docx.cleaner.DocumentCleaner

Main method for cleaning XWPFRun in whole document.

cleanParagraphs() - Method in class pl.jsolve.templ4docx.strategy.BulletListInsertStrategy

cleanRows() - Method in class pl.jsolve.templ4docx.strategy.TableInsertStrategy

cleanUp() - Method in class pl.jsolve.templ4docx.strategy.InsertStrategyChooser

containsKey(String) - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

containsKey(String) - Method in class pl.jsolve.templ4docx.variable.TableVariable

containsSubKey() - Method in class pl.jsolve.templ4docx.util.Key

D

deleteMe() - Method in class pl.jsolve.templ4docx.insert.ParagraphInsert

After creating new paragraphs, the origin template paragraph should be removed.

DocumentCleaner - Class in pl.jsolve.templ4docx.cleaner

One variable may be shared by many XWPFRun.

DocumentCleaner() - Constructor for class pl.jsolve.templ4docx.cleaner.DocumentCleaner

DocumentExecutor - Class in pl.jsolve.templ4docx.executor

This class uses variableFinder to generate list of Insert, and then begins the process of filling a template.

DocumentExecutor(Variables) - Constructor for class pl.jsolve.templ4docx.executor.DocumentExecutor

Docx - Class in pl.jsolve.templ4docx.core

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

Docx(String) - Constructor for class pl.jsolve.templ4docx.core.Docx

Docx(InputStream) - Constructor for class pl.jsolve.templ4docx.core.Docx

E

execute(Docx) - Method in class pl.jsolve.templ4docx.executor.DocumentExecutor

This method replaces variables in docx template.

extract(String, VariablePattern) - Method in class pl.jsolve.templ4docx.extractor.VariablesExtractor

Main method responsible for extract all variables which satisfy given variable pattern.

extractKeys(Variables) - Method in class pl.jsolve.templ4docx.extractor.KeyExtractor

Utility method which returns list of keys for all variables added to Variables object

F

fillTemplate(Variables) - Method in class pl.jsolve.templ4docx.core.Docx

Method replaces found variable to value provided by user

find(XWPFDocument, Variables) - Method in class pl.jsolve.templ4docx.extractor.VariableFinder

Returns list of inserts for found variables.

findImageTypeForPath(String) - Static method in enum pl.jsolve.templ4docx.variable.ImageType

findVariables() - Method in class pl.jsolve.templ4docx.core.Docx

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

G

getBulletListVariables() - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

getBulletListVariables() - Method in class pl.jsolve.templ4docx.variable.Variables

getCell() - Method in class pl.jsolve.templ4docx.insert.TableCellInsert

getCellInserts() - Method in class pl.jsolve.templ4docx.insert.TableRowInsert

getCellParent() - Method in class pl.jsolve.templ4docx.insert.ParagraphInsert

getDocumentParent() - Method in class pl.jsolve.templ4docx.insert.ParagraphInsert

getExtension() - Method in enum pl.jsolve.templ4docx.variable.ImageType

getFirstSubKey() - Method in class pl.jsolve.templ4docx.util.Key

getHeight() - Method in class pl.jsolve.templ4docx.variable.ImageVariable

getImageFile() - Method in class pl.jsolve.templ4docx.variable.ImageVariable

getImagePath() - Method in class pl.jsolve.templ4docx.variable.ImageVariable

getImageStream() - Method in class pl.jsolve.templ4docx.variable.ImageVariable

getImageType() - Method in enum pl.jsolve.templ4docx.variable.ImageType

getImageType() - Method in class pl.jsolve.templ4docx.variable.ImageVariable

getImageVariables() - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

getImageVariables() - Method in class pl.jsolve.templ4docx.variable.Variables

getKey() - Method in class pl.jsolve.templ4docx.insert.Insert

getKey() - Method in class pl.jsolve.templ4docx.util.Key

getKey() - Method in class pl.jsolve.templ4docx.variable.BulletListVariable

getKey() - Method in class pl.jsolve.templ4docx.variable.ImageVariable

getKey() - Method in class pl.jsolve.templ4docx.variable.TextVariable

getKeys() - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

getKeys() - Method in class pl.jsolve.templ4docx.variable.TableVariable

getMessage() - Method in exception pl.jsolve.templ4docx.exception.IncorrectNumberOfRowsException

getMessage() - Method in exception pl.jsolve.templ4docx.exception.OpenDocxException

getMessage() - Method in exception pl.jsolve.templ4docx.exception.UnsupportedImageTypeException

getNumberOfRows() - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

getNumberOfRows() - Method in class pl.jsolve.templ4docx.variable.TableVariable

getOriginalPrefix() - Method in class pl.jsolve.templ4docx.core.VariablePattern

getOriginalSuffix() - Method in class pl.jsolve.templ4docx.core.VariablePattern

getParagraph() - Method in class pl.jsolve.templ4docx.insert.ImageInsert

getParagraph() - Method in class pl.jsolve.templ4docx.insert.ParagraphInsert

getParagraph() - Method in class pl.jsolve.templ4docx.insert.TextInsert

getParagraphs() - Method in class pl.jsolve.templ4docx.cleaner.ParagraphCleaner

Get list of paragraphs which should be removed from document

getPrefix() - Method in class pl.jsolve.templ4docx.core.VariablePattern

getRow() - Method in class pl.jsolve.templ4docx.insert.TableRowInsert

getRowIndex() - Method in class pl.jsolve.templ4docx.util.RowInsert

getRows() - Method in class pl.jsolve.templ4docx.cleaner.TableRowCleaner

Return list of rows which should be removed

getSubKeys() - Method in class pl.jsolve.templ4docx.util.Key

getSuffix() - Method in class pl.jsolve.templ4docx.core.VariablePattern

getTableVariable() - Method in class pl.jsolve.templ4docx.util.RowInsert

getTableVariables() - Method in class pl.jsolve.templ4docx.variable.Variables

getTextVariables() - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

getTextVariables() - Method in class pl.jsolve.templ4docx.variable.Variables

getValue() - Method in class pl.jsolve.templ4docx.variable.TextVariable

getVariable(Key, int) - Method in class pl.jsolve.templ4docx.variable.TableOldVariable

getVariable(Key, int) - Method in class pl.jsolve.templ4docx.variable.TableVariable

getVariable(Key) - Method in class pl.jsolve.templ4docx.variable.Variables

getVariables() - Method in class pl.jsolve.templ4docx.variable.BulletListVariable

getVariables() - Method in class pl.jsolve.templ4docx.variable.TableVariable

getVariableType() - Method in class pl.jsolve.templ4docx.util.Key

getWidth() - Method in class pl.jsolve.templ4docx.variable.ImageVariable

getXWPFDocument() - Method in class pl.jsolve.templ4docx.core.Docx

Returns opened XWPFDocument

I

ImageInsert - Class in pl.jsolve.templ4docx.insert

Insert for image variable.

ImageInsert(Key, XWPFParagraph) - Constructor for class pl.jsolve.templ4docx.insert.ImageInsert

ImageInsertStrategy - Class in pl.jsolve.templ4docx.strategy

ImageInsertStrategy() - Constructor for class pl.jsolve.templ4docx.strategy.ImageInsertStrategy

ImageType - Enum in pl.jsolve.templ4docx.variable

Class represents supported image types.

ImageVariable - Class in pl.jsolve.templ4docx.variable

ImageVariable(String, String, int, int) - Constructor for class pl.jsolve.templ4docx.variable.ImageVariable

ImageVariable(String, File, int, int) - Constructor for class pl.jsolve.templ4docx.variable.ImageVariable

ImageVariable(String, String, ImageType, int, int) - Constructor for class pl.jsolve.templ4docx.variable.ImageVariable

ImageVariable(String, File, ImageType, int, int) - Constructor for class pl.jsolve.templ4docx.variable.ImageVariable

ImageVariable(String, InputStream, ImageType, int, int) - Constructor for class pl.jsolve.templ4docx.variable.ImageVariable

IncorrectNumberOfRowsException - Exception in pl.jsolve.templ4docx.exception

Thrown when number of values for given variable is different than number of values for another variable in the same row.

IncorrectNumberOfRowsException(String) - Constructor for exception pl.jsolve.templ4docx.exception.IncorrectNumberOfRowsException

Insert - Class in pl.jsolve.templ4docx.insert

Insert which is equal to one found variable.

Insert(Key) - Constructor for class pl.jsolve.templ4docx.insert.Insert

insert(Insert, Variable) - Method in class pl.jsolve.templ4docx.strategy.BulletListInsertStrategy

insert(Insert, Variable) - Method in class pl.jsolve.templ4docx.strategy.ImageInsertStrategy

insert(Insert, Variable) - Method in interface pl.jsolve.templ4docx.strategy.InsertStrategy

insert(Insert, Variable) - Method in class pl.jsolve.templ4docx.strategy.TableInsertStrategy

insert(Insert, Variable) - Method in class pl.jsolve.templ4docx.strategy.TextInsertStrategy

InsertStrategy - Interface in pl.jsolve.templ4docx.strategy

InsertStrategyChooser - Class in pl.jsolve.templ4docx.strategy

InsertStrategyChooser(Variables, TableRowCleaner, ParagraphCleaner) - Constructor for class pl.jsolve.templ4docx.strategy.InsertStrategyChooser

K

key - Variable in class pl.jsolve.templ4docx.insert.Insert

Key - information about found variable

Key - Class in pl.jsolve.templ4docx.util

Key(String, VariableType) - Constructor for class pl.jsolve.templ4docx.util.Key

KeyExtractor - Class in pl.jsolve.templ4docx.extractor

Utility class which returns list of keys for all variables added to Variables object

KeyExtractor() - Constructor for class pl.jsolve.templ4docx.extractor.KeyExtractor

M

Main - Class in pl.jsolve.templ4docx

Created by Łukasz on 2016-08-11.

Main() - Constructor for class pl.jsolve.templ4docx.Main

main(String[]) - Static method in class pl.jsolve.templ4docx.Main

O

OpenDocxException - Exception in pl.jsolve.templ4docx.exception

Thrown when .docx file doesn't exist or when another exception is thrown while template processing.

OpenDocxException(String, Throwable) - Constructor for exception pl.jsolve.templ4docx.exception.OpenDocxException

P

ParagraphCleaner - Class in pl.jsolve.templ4docx.cleaner

Container class which contains information about paragraphs intended to remove.

ParagraphCleaner() - Constructor for class pl.jsolve.templ4docx.cleaner.ParagraphCleaner

ParagraphInsert - Class in pl.jsolve.templ4docx.insert

Abstract paragraph insert.

ParagraphInsert(Key, XWPFParagraph, XWPFTableCell, XWPFDocument) - Constructor for class pl.jsolve.templ4docx.insert.ParagraphInsert

pl.jsolve.templ4docx - package pl.jsolve.templ4docx

pl.jsolve.templ4docx.cleaner - package pl.jsolve.templ4docx.cleaner

pl.jsolve.templ4docx.core - package pl.jsolve.templ4docx.core

pl.jsolve.templ4docx.exception - package pl.jsolve.templ4docx.exception

pl.jsolve.templ4docx.executor - package pl.jsolve.templ4docx.executor

pl.jsolve.templ4docx.extractor - package pl.jsolve.templ4docx.extractor

pl.jsolve.templ4docx.insert - package pl.jsolve.templ4docx.insert

pl.jsolve.templ4docx.strategy - package pl.jsolve.templ4docx.strategy

pl.jsolve.templ4docx.util - package pl.jsolve.templ4docx.util

pl.jsolve.templ4docx.variable - package pl.jsolve.templ4docx.variable

R

readTextContent() - Method in class pl.jsolve.templ4docx.core.Docx

Returns text content as String

replace(List<Insert>) - Method in class pl.jsolve.templ4docx.extractor.VariableFinder

Execute appropriate strategy for each insert.

replace(Insert, Variable) - Method in class pl.jsolve.templ4docx.strategy.InsertStrategyChooser

replace(Insert) - Method in class pl.jsolve.templ4docx.strategy.InsertStrategyChooser

RowInsert - Class in pl.jsolve.templ4docx.util

RowInsert(int, TableVariable) - Constructor for class pl.jsolve.templ4docx.util.RowInsert

S

save(String) - Method in class pl.jsolve.templ4docx.core.Docx

Save filled template as new .docx file

save(OutputStream) - Method in class pl.jsolve.templ4docx.core.Docx

Save filled template as new .docx file

setCell(XWPFTableCell) - Method in class pl.jsolve.templ4docx.insert.TableCellInsert

setKey(Key) - Method in class pl.jsolve.templ4docx.insert.Insert

setVariablePattern(VariablePattern) - Method in class pl.jsolve.templ4docx.core.Docx

Set variable pattern which indicates how the variable looks like

T

TableCellInsert - Class in pl.jsolve.templ4docx.insert

Insert for table cell variable.

TableCellInsert(Key, XWPFTableCell) - Constructor for class pl.jsolve.templ4docx.insert.TableCellInsert

TableInsertStrategy - Class in pl.jsolve.templ4docx.strategy

TableInsertStrategy(Variables, InsertStrategyChooser, TableRowCleaner) - Constructor for class pl.jsolve.templ4docx.strategy.TableInsertStrategy

TableOldVariable - Class in pl.jsolve.templ4docx.variable

TableOldVariable() - Constructor for class pl.jsolve.templ4docx.variable.TableOldVariable

TableRowCleaner - Class in pl.jsolve.templ4docx.cleaner

Container class which contains information about rows intended to remove.

TableRowCleaner() - Constructor for class pl.jsolve.templ4docx.cleaner.TableRowCleaner

TableRowInsert - Class in pl.jsolve.templ4docx.insert

Insert for table row variable.

TableRowInsert() - Constructor for class pl.jsolve.templ4docx.insert.TableRowInsert

TableVariable - Class in pl.jsolve.templ4docx.variable

TableVariable() - Constructor for class pl.jsolve.templ4docx.variable.TableVariable

TextInsert - Class in pl.jsolve.templ4docx.insert

Insert for text variable.

TextInsert(Key, XWPFParagraph) - Constructor for class pl.jsolve.templ4docx.insert.TextInsert

TextInsertStrategy - Class in pl.jsolve.templ4docx.strategy

TextInsertStrategy() - Constructor for class pl.jsolve.templ4docx.strategy.TextInsertStrategy

TextVariable - Class in pl.jsolve.templ4docx.variable

TextVariable(String, String) - Constructor for class pl.jsolve.templ4docx.variable.TextVariable

toString() - Method in exception pl.jsolve.templ4docx.exception.IncorrectNumberOfRowsException

toString() - Method in exception pl.jsolve.templ4docx.exception.OpenDocxException

toString() - Method in exception pl.jsolve.templ4docx.exception.UnsupportedImageTypeException

toString() - Method in class pl.jsolve.templ4docx.insert.Insert

toString() - Method in class pl.jsolve.templ4docx.insert.TableRowInsert

toString() - Method in class pl.jsolve.templ4docx.util.Key

U

UnsupportedImageTypeException - Exception in pl.jsolve.templ4docx.exception

Thrown when image type is not supported.

UnsupportedImageTypeException(String) - Constructor for exception pl.jsolve.templ4docx.exception.UnsupportedImageTypeException

V

valueOf(String) - Static method in enum pl.jsolve.templ4docx.util.VariableType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum pl.jsolve.templ4docx.variable.ImageType

Returns the enum constant of this type with the specified name.

values() - Static method in enum pl.jsolve.templ4docx.util.VariableType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum pl.jsolve.templ4docx.variable.ImageType

Returns an array containing the constants of this enum type, in the order they are declared.

Variable - Interface in pl.jsolve.templ4docx.variable

VariableFinder - Class in pl.jsolve.templ4docx.extractor

Utility class responsible for preparing list of inserts.

VariableFinder(Variables) - Constructor for class pl.jsolve.templ4docx.extractor.VariableFinder

VariablePattern - Class in pl.jsolve.templ4docx.core

Class represents pattern of variable in .docx document.

VariablePattern(String, String) - Constructor for class pl.jsolve.templ4docx.core.VariablePattern

Variables - Class in pl.jsolve.templ4docx.variable

Variables() - Constructor for class pl.jsolve.templ4docx.variable.Variables

VariablesExtractor - Class in pl.jsolve.templ4docx.extractor

Utility class which returns list of variables found in text content of template .docx file

VariablesExtractor() - Constructor for class pl.jsolve.templ4docx.extractor.VariablesExtractor

VariableType - Enum in pl.jsolve.templ4docx.util

A B C D E F G I K M O P R S T U V