com.plusmpm.CUF.util.extension.DocTemplates2Pdf

Class PrepeareDoc

java.lang.Object

com.plusmpm.CUF.util.extension.DocTemplates2Pdf.PrepeareDoc

public class PrepeareDoc
extends Object

Klasa umożliwiająca stworzenie wypełnionego dokumentu .pdf na postawie szablonu docx z odpowiednio zaznaczonymi zmiennymi do uzupełnienia.

Author:

Patryk Promiński 2011-03-24

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log
static String	TAB_NOT_TO_PROC_STR
static String	TAB_TO_PROC_STR
static String	TAB_WOUT_HDS_STRING
static String	VARIABLE_MARKER

Constructor Summary

Constructors

Constructor and Description
PrepeareDoc()

Method Summary

Modifier and Type	Method and Description
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 void	createTableWithValues(org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mdp, int iTableNr, org.docx4j.wml.Tbl table, Map<String,String> mValues, List<Map<String,Object>> lParagraphProperties) Metoda, która na podstawie mapy tworzy wypełnioną tabelę w szablonie docx.
static void	createTableWithValues(org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mdp, org.docx4j.wml.Tbl table, List<String> lValues, List<Map<String,Object>> lParagraphProperties, ColumnGraphicInfo columnGraphicInfo, org.docx4j.openpackaging.packages.WordprocessingMLPackage template) Metoda, która na podstawie mapy tworzy wypełnioną tabelę w szablonie docx.
static void	createTableWithValues(org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mdp, org.docx4j.wml.Tbl table, List<String> lValues, List<Map<String,Object>> lParagraphProperties, org.docx4j.wml.TrPr rowProperties, ColumnGraphicInfo columnGraphicInfo, org.docx4j.openpackaging.packages.WordprocessingMLPackage template)
static File	doc2PdfWithoutOO(String sInputFilePathDocx, String sOutputFilePathPdf) Metoda, która generuje dokument .pdf z podanego w parametrach pliku .docx bez użycia OpenOfficeService
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 File	prepareDocument(String templatePath, String outputFilePath, Map<String,Object> mappings, List<Map<String,String>> tablesMaps, String variablesMarker, String processId, List<Boolean> tablesAdditionalFlags, List<Boolean> headersAdditionalFlags, boolean pdf)
static void	prepareHeaderFooter(org.docx4j.openpackaging.packages.WordprocessingMLPackage wordMLPackage, Map<String,Object> mappings, String sVariablesMarker)
static File	prepeareWordDocument(String templatePath, String outputFilePath, Map<String,Object> mappings, List<Map<String,String>> tables, String variablesMarker, String processId, List<Boolean> headersAdditionalFlags, List<Boolean> tablesAdditionalFlags) Metoda, która z podanego szablonu (np. szablon.docx) tworzy nowy dokument szablon_tmp.docx, z wypełnionymi zmiennymi (zmienne w szablonie należy podawać w pomiędzy znacznikami, które są zdefiniowane jako sVariablesMarker Nie należy w szablonie wykorzystywać tych znaczników, w innym celu niż zaznaczanie zmiennych (w innych fragmentach szablonu).
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

Field Detail

log

public static org.apache.log4j.Logger log

TAB_TO_PROC_STR

public static final String TAB_TO_PROC_STR

See Also:

Constant Field Values

TAB_NOT_TO_PROC_STR

public static final String TAB_NOT_TO_PROC_STR

See Also:

Constant Field Values

TAB_WOUT_HDS_STRING

public static final String TAB_WOUT_HDS_STRING

See Also:

Constant Field Values

VARIABLE_MARKER

public static final String VARIABLE_MARKER

See Also:

Constant Field Values

Constructor Detail

PrepeareDoc

public PrepeareDoc()

Method Detail

prepeareWordDocument

public static File prepeareWordDocument(String templatePath,
                                        String outputFilePath,
                                        Map<String,Object> mappings,
                                        List<Map<String,String>> tables,
                                        String variablesMarker,
                                        String processId,
                                        List<Boolean> headersAdditionalFlags,
                                        List<Boolean> tablesAdditionalFlags)

Metoda, która z podanego szablonu (np. szablon.docx) tworzy nowy dokument szablon_tmp.docx, z wypełnionymi zmiennymi (zmienne w szablonie należy podawać w pomiędzy znacznikami, które są zdefiniowane jako sVariablesMarker Nie należy w szablonie wykorzystywać tych znaczników, w innym celu niż zaznaczanie zmiennych (w innych fragmentach szablonu).

Parameters:

templatePath - - ścieżka do szablonu

outputFilePath - - ścieżka do pdfu, który będzie utworzony przez inną metodę

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

tables - - 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 kojelnych wierszy (np. wartosc1;wartosc2;wartosc3;...)

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. "@")

processId - - id procesu

headersAdditionalFlags - - flagi stanowiące o tym, czy dane konkretnego nagłówka mają zostać pobrane

tablesAdditionalFlags - - flagi stanowiące o tym, czy dane konkretnej tabeli mają zostać pobrane

Returns:

Throws:

org.docx4j.openpackaging.exceptions.Docx4JException

JAXBException

prepareDocument

public static File prepareDocument(String templatePath,
                                   String outputFilePath,
                                   Map<String,Object> mappings,
                                   List<Map<String,String>> tablesMaps,
                                   String variablesMarker,
                                   String processId,
                                   List<Boolean> tablesAdditionalFlags,
                                   List<Boolean> headersAdditionalFlags,
                                   boolean pdf)

prepareHeaderFooter

public static void prepareHeaderFooter(org.docx4j.openpackaging.packages.WordprocessingMLPackage wordMLPackage,
                                       Map<String,Object> mappings,
                                       String sVariablesMarker)

createTableWithValues

public static void createTableWithValues(org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mdp,
                                         int iTableNr,
                                         org.docx4j.wml.Tbl table,
                                         Map<String,String> mValues,
                                         List<Map<String,Object>> lParagraphProperties)

Metoda, która na podstawie mapy tworzy wypełnioną tabelę w szablonie docx. W szablonie powinna znajdować się tabela o jednym wierszu, odpowiedniej ilości kolumn, a w komórkach powinny znajdować się zmienne, które zostaną zastąpione nazwami nagłówków kolumn.

Parameters:

mdp - - pobrany z szablonu główny człon dokumentu docx

iTableNr - -numer tabeli w danym dokumnecie (gdyby była więcej niż jedna tabela)

table - - pobrany element z xmla definiującego dokument docx, opisujący tabelę

mValues - - mapa której klucze wskazują kolumnę (tNR_TABELIcNR_KOLUMNY np. t1c1), a w wartości po średnikach wartości w zadanej kolumnie, dla kojelnych wierszy (np. wartosc1;wartosc2;wartosc3;...)

Throws:

org.docx4j.openpackaging.exceptions.Docx4JException

JAXBException

createTableWithValues

public static void createTableWithValues(org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mdp,
                                         org.docx4j.wml.Tbl table,
                                         List<String> lValues,
                                         List<Map<String,Object>> lParagraphProperties,
                                         ColumnGraphicInfo columnGraphicInfo,
                                         org.docx4j.openpackaging.packages.WordprocessingMLPackage template)

Metoda, która na podstawie mapy tworzy wypełnioną tabelę w szablonie docx. W szablonie powinna znajdować się tabela o jednym wierszu, odpowiedniej ilości kolumn, a w komórkach powinny znajdować się zmienne, które zostaną zastąpione nazwami nagłówków kolumn.

Parameters:

mdp - - pobrany z szablony główny człon dokumentu docx

iTableNr - -numer tabeli w danym dokumnecie (gdyby była więcej niż jedna tabela)

table - - pobrany element z xmla definiującego dokument docx, opisujący tabelę

lValues - - mapa której klucze wskazują kolumnę (tNR_TABELIcNR_KOLUMNY np. t1c1), a w wartości po średnikach wartości w zadanej kolumnie, dla kojelnych wierszy (np. wartosc1;wartosc2;wartosc3;...)

rowProperties -

columnGraphicInfo -

template -

rowProperties -

Throws:

org.docx4j.openpackaging.exceptions.Docx4JException

JAXBException

createTableWithValues

public static void createTableWithValues(org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mdp,
                                         org.docx4j.wml.Tbl table,
                                         List<String> lValues,
                                         List<Map<String,Object>> lParagraphProperties,
                                         org.docx4j.wml.TrPr rowProperties,
                                         ColumnGraphicInfo columnGraphicInfo,
                                         org.docx4j.openpackaging.packages.WordprocessingMLPackage template)

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. "@")

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. "@")

doc2PdfWithoutOO

public static File doc2PdfWithoutOO(String sInputFilePathDocx,
                                    String sOutputFilePathPdf)

Metoda, która generuje dokument .pdf z podanego w parametrach pliku .docx bez użycia OpenOfficeService

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

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"