com.plusmpm.CUF.util.extension.DocTemplates2Pdf.workflow

Class WorkflowUtils

java.lang.Object

com.plusmpm.CUF.util.extension.DocTemplates2Pdf.workflow.WorkflowUtils

public class WorkflowUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
WorkflowUtils()

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	addFullUserNames(String newTemplate, String variablesMarker, Map<String,Object> mappings)
static Long	createDocAndSaveInArchive(String sInputFilePathOldDocx, String sOutputDocClassName, HashMap<String,String> hmMappings, List<Map<String,String>> lTables, Map<String,Object> mOptionalParameters, boolean pdf)
static Long	createPdfAndSaveInArchive(String sInputFilePathOldDocx, String sOutputDocClassName, HashMap<String,String> hmMappings, List<Map<String,String>> lTables, Map<String,Object> mOptionalParameters) Metoda, która tworzy dokument .pdf z dokumentu doc/docx (z uzupełnionego szablonu docx tworzy .pdf)
static Long	createPdfAndSaveInArchive(String sInputFilePathOldDocx, String sOutputDocClassName, Map<String,Object> mMappings, String sProcessId, Map<String,Object> mOptionalParameters) Metoda, która tworzy dokument .pdf z dokumentu doc/docx (z uzupełnionego szablonu docx tworzy .pdf)
static Long	createPdfAndSaveInArchive(String sInputFilePathOldDocx, String sOutputDocClassName, String sProcessId, Map<String,Object> mOptionalParameters) Metoda, która tworzy dokument .pdf z dokumentu doc/docx (z uzupełnionego szablonu docx tworzy .pdf)
static String	getProcessDefId(String processId)
static String	mergeVariablesTextNodes(String sTemplate, String sVariablesMarker, Map<String,Object> variables) Metoda, która usuwa z szablonu zbędne dodatkowe informacje pojawiające się przy kolejnym zapisie pliku docx, zaburzające pracę metody wstawiającej zmienne do szablonu.
static <E> void	replaceVariablesAndSave(org.docx4j.openpackaging.parts.JaxbXmlPart<E> part, Map<String,Object> mappings, String sVariablesMarker)
static String	replaceVariablesInTemplate(String template, Map<String,Object> mappings, String variablesMarker) Metoda, która wstawia wartości zmiennych do szablonu (tutaj szablon jest przygotowywany do uzupełnienia, znaczniki zmiennych @zmienna@ są zamieniane na znaki dolara $ -> $zmienna$, dlatego też zarówno @ jak i $ nie mogą być wykorzystywane w dokumencie poza znacznikami zmiennych.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowUtils

public WorkflowUtils()

Method Detail

getProcessDefId

public static String getProcessDefId(String processId)
                              throws Exception

Throws:

Exception

replaceVariablesAndSave

public static <E> void replaceVariablesAndSave(org.docx4j.openpackaging.parts.JaxbXmlPart<E> part,
                                               Map<String,Object> mappings,
                                               String sVariablesMarker)

replaceVariablesInTemplate

public static String replaceVariablesInTemplate(String template,
                                                Map<String,Object> mappings,
                                                String variablesMarker)

Metoda, która wstawia wartości zmiennych do szablonu (tutaj szablon jest przygotowywany do uzupełnienia, znaczniki zmiennych @zmienna@ są zamieniane na znaki dolara $ -> $zmienna$, dlatego też zarówno @ jak i $ nie mogą być wykorzystywane w dokumencie poza znacznikami zmiennych.

Parameters:

template - - treść szablonu docx w formacie xml (document.xml) przed wypełnieniem zmiennych

mappings - - mapa przechowująca w kluczach nazwy zmiennych wyszukiwane w dokumencie, a w wartościach to czym mające te zmienne zostać zastąpione

variablesMarker - - zmienna przechowująca ciąg znaków będący znacznikiem umożliwiającym rozpoznanie w w dokumencie zmiennych, które mają zostać zastąpione wartościami (ze względu na działania MSWord ciąg znaków rozumiem tutaj jako jeden znak np. "@")

addFullUserNames

public static Map<String,Object> addFullUserNames(String newTemplate,
                                                  String variablesMarker,
                                                  Map<String,Object> mappings)

createPdfAndSaveInArchive

public static Long createPdfAndSaveInArchive(String sInputFilePathOldDocx,
                                             String sOutputDocClassName,
                                             HashMap<String,String> hmMappings,
                                             List<Map<String,String>> lTables,
                                             Map<String,Object> mOptionalParameters)

Metoda, która tworzy dokument .pdf z dokumentu doc/docx (z uzupełnionego szablonu docx tworzy .pdf)

Parameters:

sInputFilePathDocx - - ścieżka do pliku (docx - uzupełniony szablon), z którego ma zostać stworzony .pdf

sOutputDocClassName - - nazwa klasy, do której ma zostać dołączony wygenerowany dokument .pdf

hmMappings - - mapa przechowująca w kluczach nazwy zmiennych wyszukiwane w dokumencie, a w wartościach to czym mające te zmienne zostać zastąpione

lTables - - lista map, definiująca tabele znajdujące się w dokumencie, każda tabela to osobna mapa, której klucze wskazują kolumnę (tNR_TABELIcNR_KOLUMNY np. t1c1), a w wartości po średnikach wartości w zadanej kolumnie, dla kolejnych wierszy (np. wartosc1;wartosc2;wartosc3;...)

mOptionalParameters - - mapa przechowująca dodatkowe parametry (na chwilę obecną parametry to: * parametr przechowujący ciąg znaków będący znacznikiem umożliwiającym rozpoznanie w dokumencie zmiennych, które mają zostać zastąpione wartościami, ze względu na działania MSWord ciąg znaków rozumiem tutaj jako jeden znak np. "@") - wartość parametru przechowywana jest przy kluczu "variablesMarker" * parametr mówiący czy dokument ma być podłączony jako nowa wersja jeśli wartości indeksów się powtarzają - "documentNewVersion" ("TRUE" lub FALSE") * parametr w którym przekazujemy opis podłączonego domuentu jeśli chcemy żeby był inny niż nazwa klasy - "documentDescription" * parametr, w którym jako obiektp rzekazujemy tablice typu String zawierającą indkesy dla danego dokumentu - "documentIndices"

createDocAndSaveInArchive

public static Long createDocAndSaveInArchive(String sInputFilePathOldDocx,
                                             String sOutputDocClassName,
                                             HashMap<String,String> hmMappings,
                                             List<Map<String,String>> lTables,
                                             Map<String,Object> mOptionalParameters,
                                             boolean pdf)

createPdfAndSaveInArchive

public static Long createPdfAndSaveInArchive(String sInputFilePathOldDocx,
                                             String sOutputDocClassName,
                                             String sProcessId,
                                             Map<String,Object> mOptionalParameters)

Metoda, która tworzy dokument .pdf z dokumentu doc/docx (z uzupełnionego szablonu docx tworzy .pdf)

Parameters:

sInputFilePathDocx - - ścieżka do pliku (docx - uzupełniony szablon), z którego ma zostać stworzony .pdf

sOutputDocClassName - - nazwa klasy, do której ma zostać dołączony wygenerowany dokument .pdf

sProcessId - - id procesu z którego będą pobierane wartości zmiennych do uzupełnienia

mOptionalParameters - - mapa przechowująca dodatkowe parametry (na chwilę obecną parametry to: * parametr przechowujący ciąg znaków będący znacznikiem umożliwiającym rozpoznanie w dokumencie zmiennych, które mają zostać zastąpione wartościami, ze względu na działania MSWord ciąg znaków rozumiem tutaj jako jeden znak np. "@") - wartość parametru przechowywana jest przy kluczu "variablesMarker" * parametr mówiący czy dokument ma być podłączony jako nowa wersja jeśli wartości indeksów się powtarzają - "documentNewVersion" ("TRUE" lub FALSE") * parametr w którym przekazujemy opis podłączonego domuentu jeśli chcemy żeby był inny niż nazwa klasy - "documentDescription" * parametr, w którym jako obiektp rzekazujemy tablice typu String zawierającą indkesy dla danego dokumentu - "documentIndices"

createPdfAndSaveInArchive

public static Long createPdfAndSaveInArchive(String sInputFilePathOldDocx,
                                             String sOutputDocClassName,
                                             Map<String,Object> mMappings,
                                             String sProcessId,
                                             Map<String,Object> mOptionalParameters)

Metoda, która tworzy dokument .pdf z dokumentu doc/docx (z uzupełnionego szablonu docx tworzy .pdf)

Parameters:

sInputFilePathDocx - - ścieżka do pliku (docx - uzupełniony szablon), z którego ma zostać stworzony .pdf

sOutputDocClassName - - nazwa klasy, do której ma zostać dołączony wygenerowany dokument .pdf

mMappings - - mapa przechowująca w kluczach nazwy zmiennych wyszukiwane w szablonie, a w wartościach to czym mają te zmienne zostać zastąpione

sProcessId - - konieczne by pobrać processDefinitionId, na podstawie którego nagłówki kolumn mogą być ustawione na wartośći zgodne z nagłówkami kolumn tabeli dynamicznej na formularzu

mOptionalParameters - - mapa przechowująca dodatkowe parametry (na chwilę obecną parametry to: * parametr przechowujący ciąg znaków będący znacznikiem umożliwiającym rozpoznanie w dokumencie zmiennych, które mają zostać zastąpione wartościami, ze względu na działania MSWord ciąg znaków rozumiem tutaj jako jeden znak np. "@") - wartość parametru przechowywana jest przy kluczu "variablesMarker" * parametr mówiący czy dokument ma być podłączony jako nowa wersja jeśli wartości indeksów się powtarzają - "documentNewVersion" ("TRUE" lub FALSE") * parametr w którym przekazujemy opis podłączonego dokumentu jeśli chcemy żeby był inny niż nazwa klasy - "documentDescription" * parametr, w którym jako obiektp rzekazujemy tablice typu String zawierającą indkesy dla danego dokumentu - "documentIndices"

mergeVariablesTextNodes

public static String mergeVariablesTextNodes(String sTemplate,
                                             String sVariablesMarker,
                                             Map<String,Object> variables)

Metoda, która usuwa z szablonu zbędne dodatkowe informacje pojawiające się przy kolejnym zapisie pliku docx, zaburzające pracę metody wstawiającej zmienne do szablonu.

Parameters:

sTemplate - - treść szablonu docx w formacie xml (document.xml) przed wypełnieniem zmiennych

sVariablesMarker - - zmienna przechowująca ciąg znaków będący znacznikiem umożliwiającym rozpoznanie w w dokumencie zmiennych, które mają zostać zastąpione wartościami (ze względu na działania MSWord ciąg znaków rozumiem tutaj jako jeden znak np. "@")