palio.modules.pdf
Class PDFDocument

java.lang.Object
  palio.modules.pdf.PDFDocument

public class PDFDocument
extends java.lang.Object

Klasa reprezentująca dokument. Dokument można rozumieć jako abstrakcyjny twór posiadający :

• matrycę(szablon) - niewypełniony dokument PDF
• tablicę obiektów - to one odpowiadają za wypełnianie pól matrycy danymi z bazy.

Dokument posiada też strumień wyjściowy ( plik). Zapisywany jest do niego dokument powstały w wyniku nałożenia na matrycę pól i wypełnienia ich podanymi danymi.

Version:

1.0, 04/11/09

Author:

Krzysztof Łuszyński TORN

Constructor Summary

PDFDocument(java.net.URL _url, int _id, java.io.FileOutputStream _out, java.lang.String _name)
Konstruktor klasy PDFDocument.

Method Summary

void	add(PDFObject newObject) Metoda dodająca nowy obiekt do dokumentu.
void	clearAllValues() Metoda czyszcząca wartości wszystkich obiektów dokumentu.
void	getFilledDocument() Metoda tworząca nowy dokument PDF.
int	getId() Metoda zwracająca id dokumentu.
java.util.Vector	getObjects() Metoda zwracająca obiekty dokumentu.
void	setImagesValues(java.lang.Object[] ids, java.lang.Object[] values) Metoda ustawiająca wartości wszystkich obiektów typu PDFImage.
void	setOut(java.io.FileOutputStream _out) Metoda ustawiająca strumień wyjściowy dokumentu.
void	setTextFieldsValues(java.lang.Object[] ids, java.lang.Object[] values) Metoda ustawiająca wartości wszystkich obiektów typu PDFTextField.
void	setTextFormsValues(java.lang.Object[] ids, java.lang.Object[] values) Metoda ustawiająca wartości wszystkich obiektów typu PDFTextForm.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFDocument

public PDFDocument(java.net.URL _url,
                   int _id,
                   java.io.FileOutputStream _out,
                   java.lang.String _name)

Konstruktor klasy PDFDocument.

Parameters:

_url - parametr typu java.net.URL, url matrycy.

_id - parametr typu int, id dokumentu w bazie.

_out - parametr typu java.io.FileOutputStream, wyjście do pliku.

_name - parametr typu String, nazwa dokumentu.

Method Detail

getId

public int getId()

Metoda zwracająca id dokumentu.

Returns:

zmienna typu int, id dokumentu w bazie.

getObjects

public java.util.Vector getObjects()

Metoda zwracająca obiekty dokumentu.

Returns:

obiekt typu Vector, obiekty dokumentu.

add

public void add(PDFObject newObject)

Metoda dodająca nowy obiekt do dokumentu.

Parameters:

newObject - parametr typu PDFObject, nowy obiekt.

setOut

public void setOut(java.io.FileOutputStream _out)

Metoda ustawiająca strumień wyjściowy dokumentu.

Parameters:

_out - parametr typu java.io.FileOutputStream, strumień wyjściowy.

clearAllValues

public void clearAllValues()
                    throws PDFException

Metoda czyszcząca wartości wszystkich obiektów dokumentu. Ustawia wszystkie wartości na null.

Throws:

PDFException - gdy wystąpi błąd ( nigdy nie powinno się to zdarzyć ).

setTextFormsValues

public void setTextFormsValues(java.lang.Object[] ids,
                               java.lang.Object[] values)
                        throws PDFException

Metoda ustawiająca wartości wszystkich obiektów typu PDFTextForm.

Parameters:

ids - parametr typu Object[], tablica id.

values - parametr typu Object[], tablica wartości.

Throws:

PDFException - gdy choć jedna wartość z wektora wartości jest nieprawidłowa.

setTextFieldsValues

public void setTextFieldsValues(java.lang.Object[] ids,
                                java.lang.Object[] values)
                         throws PDFException

Metoda ustawiająca wartości wszystkich obiektów typu PDFTextField.

Parameters:

ids - parametr typu Object[], tablica id.

values - parametr typu Object[], tablica wartości.

Throws:

PDFException - gdy choć jedna wartość z wektora wartości jest nieprawidłowa.

setImagesValues

public void setImagesValues(java.lang.Object[] ids,
                            java.lang.Object[] values)
                     throws PDFException

Metoda ustawiająca wartości wszystkich obiektów typu PDFImage.

Parameters:

ids - parametr typu Object[], tablica id.

values - parametr typu Object[], tablica wartości.

Throws:

PDFException - gdy choć jedna wartość z wektora wartości jest nieprawidłowa.

getFilledDocument

public void getFilledDocument()
                       throws java.lang.Exception

Metoda tworząca nowy dokument PDF. Bierze matrycę i dodaje do niej wszystkie obiekty.

Throws:

java.lang.Exception - w przypadku błędu.