palio.modules
Class Pipe

java.lang.Object
  palio.modules.core.Module
      palio.modules.Pipe

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public final class Pipe
extends palio.modules.core.Module

Moduł wspierający operacje na strumieniach.

Moduł jest dostępny w każdej instancji jPalio.

Version:

1.2.2 2007.02.17

Author:

Mateusz Gembarzewski, Krzysztof Madyniak

Field Summary

Fields inherited from interface palio.modules.core.CurrentModuleDataKeys

DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT

Constructor Summary

Pipe(palio.Instance instance, java.util.Properties parameters)

Method Summary

static void	closeReader(java.lang.Object reader) Zamyka podany strumień.
static void	closeWriter(java.lang.Object writer) Zamyka podany strumień wyjściowy
java.lang.String	getVersion() Returns the module version
static java.lang.Object	openReader(byte[] source, java.lang.String charset) Otwiera strumień za pomocą którego możemy odczytywać ze źródła kolejne linie tekstu.
static java.lang.Object	openReader(java.lang.String source) Otwiera strumień za pomocą którego możemy odczytać string linia po linii.
static java.lang.Object	openReader(java.lang.String source, java.lang.String sourceType, java.lang.String charset) Otwiera strumień za pomocą którego możemy odczytywać ze źródła kolejne linie tekstu.
static java.io.Writer	openWriter(java.lang.String dest, java.lang.String destType, java.lang.String charset) Otwiera strumień do którego można pisać kolejne linie tekstu.
static java.lang.String	readLine(java.lang.Object reader) Odczytuje z podanego strumienia kolejną linię tekstu.
static java.util.LinkedList	readLines(java.lang.Object reader) Odczytuje z podanego strumienia wszystkie dostępne linie tekstu i zwraca je w postaci listy.
static void	readLines(java.lang.Object reader, java.lang.String paramName, palio.compiler.PalioCode code) Odczytuje z podanego strumienia kolejne linie tekstu.
static void	write(java.lang.Object writer, java.lang.String str) Pisze podany ciąg znaków do strumienia wyjściowego.

Methods inherited from class palio.modules.core.Module

getConfigParam, getDescription, getModuleTranslation

Methods inherited from class java.lang.Object

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

Constructor Detail

Pipe

public Pipe(palio.Instance instance,
            java.util.Properties parameters)

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from class: palio.modules.core.Module

Returns the module version

Specified by:

getVersion in class palio.modules.core.Module

openReader

public static java.lang.Object openReader(java.lang.String source)

Otwiera strumień za pomocą którego możemy odczytać string linia po linii.

Parameters:

source - źródło (dane w postaci String'a)

Returns:

otwarty strumień tekstowy (BufferedReader)

openReader

public static java.lang.Object openReader(java.lang.String source,
                                          java.lang.String sourceType,
                                          java.lang.String charset)
                                   throws java.io.IOException

Otwiera strumień za pomocą którego możemy odczytywać ze źródła kolejne linie tekstu. Obsługiwane typy źródła: FILE, URL.

Parameters:

source - definicja źródła, np: /opt/import/file.txt lub http://localhost/pliki/dane.html

sourceType - typ źródła: FILE lub URL

charset - kodowanie źródła

Returns:

otwarty strumień tekstowy (BufferedReader)

Throws:

java.io.IOException

openReader

public static java.lang.Object openReader(byte[] source,
                                          java.lang.String charset)
                                   throws java.io.IOException

Otwiera strumień za pomocą którego możemy odczytywać ze źródła kolejne linie tekstu. Używaj tej wersji funkcji TYLKO wtedy, kiedy nie możesz użyć wersji w której podaje się definicję źródła i jego typ: openReader(String, String, String).

Parameters:

source - dane źródłowe

charset - kodowanie źródła

Returns:

otwarty strumień tekstowy (BufferedReader)

Throws:

java.io.IOException

closeReader

public static void closeReader(java.lang.Object reader)
                        throws java.io.IOException

Zamyka podany strumień.

Parameters:

reader - otwarty strumień tekstowy (BufferedReader)

Throws:

java.io.IOException

readLine

public static java.lang.String readLine(java.lang.Object reader)
                                 throws java.io.IOException

Odczytuje z podanego strumienia kolejną linię tekstu. Jeśli funkcja zwróci null, oznacza to, że ze strumienia zostały odczytane wszystkie linie tekstu a sam strumień został zamknięty.

Parameters:

reader - otwarty strumień tekstowy (BufferedReader)

Returns:

kolejna linia tekstu lub null, jeśli nie ma więcej linii

Throws:

java.io.IOException

readLines

public static java.util.LinkedList readLines(java.lang.Object reader)
                                      throws java.io.IOException

Odczytuje z podanego strumienia wszystkie dostępne linie tekstu i zwraca je w postaci listy. Po zakończeniu strumień zostanie automatycznie zamknięty.

Parameters:

reader - otwarty strumień tekstowy (BufferedReader)

Returns:

lista kolejnych linii tekstu

Throws:

java.io.IOException

readLines

public static void readLines(java.lang.Object reader,
                             java.lang.String paramName,
                             palio.compiler.PalioCode code)
                      throws java.io.IOException,
                             palio.PalioException

Odczytuje z podanego strumienia kolejne linie tekstu. Działa podobnie jak funkcja for i jest najszybszą metodą na odczytanie kolejnych linii tekstu ze strumienia. Po zakończeniu strumień zostanie automatycznie zamknięty.

Parameters:

reader - otwarty strumień tekstowy (BufferedReader)

paramName - nazwa parametru z aktualną linią teksu

code - kod wykonywany dla każdej linii

Throws:

java.io.IOException

palio.PalioException

openWriter

public static java.io.Writer openWriter(java.lang.String dest,
                                        java.lang.String destType,
                                        java.lang.String charset)
                                 throws java.io.IOException

Otwiera strumień do którego można pisać kolejne linie tekstu. Obsługiwane typy strumienia docelowego: FILE, URL.
Ważne: Po otworzeniu strumienia należy pamiętać o jego zamknięciu!

Parameters:

dest - definicja źródła, np: /opt/import/file.txt lub http://localhost/pliki/dane.html

destType - typ źródła: FILE lub URL

charset - kodowanie źródła

Returns:

otwarty strumień tekstowy (BufferedWriter)

Throws:

java.io.IOException

See Also:

closeWriter(Object)

closeWriter

public static void closeWriter(java.lang.Object writer)
                        throws java.io.IOException

Zamyka podany strumień wyjściowy

Parameters:

writer - otwarty strumień wyjściowy

Throws:

java.io.IOException

write

public static void write(java.lang.Object writer,
                         java.lang.String str)
                  throws java.io.IOException

Pisze podany ciąg znaków do strumienia wyjściowego. Metoda nie dodaje znaków końca linii.

Parameters:

writer - otwarty strumień wyjściowy

str - ciąg znaków

Throws:

java.io.IOException