Heiner Kücker

Multi Markable Buffered InputStream

Home

Java-Seite

 . Weiterentwicklung_Java

 . WebCam_Demo

 . JSP WorkFlow
 . PageFlow FlowControl
 . Page Flow Engine
 . Web Flow Engine
 . Control_and_Command

 . JSP_Spreadsheet

 . Kognitions-Maschine
 . semantisches Netz

 . Domain Parser

 . Codegenerator_für
 . hierarchische
 . Datenstrukturen

 . Expression_Engine
 . Formula_Parser

 . Thread Preprocessor

 . State Transition Engine

 . AspectJ

 . Java_Explorer

 . DBF_Library

 . Kalender_Applet

 . SetGetGen

 . BeanSetGet

 . CheckPackage

 . LineNumbers

 . GradDms

 . Excel-Export

 . StringTokenizer

 . JspDoc

 . JspCheck

 . JSP-Schulung
 . Java Server Pages
 . Struts

 . Ascii-Tabellen-
 . Layouter

 . Ascii-Baum-
 . Layouter

 . Ascii-Art-Fluss-
 . Diagramm-
 . Parser

 . AsciiArt
 . AssignmentMatrix
 . Layouter

 . StringSerial

 . Silbentrennung

 . JDBC_Schlüssel-
 . Generierung

 . bidirektional/
 . unidirektional
 . gelinkte Liste

 . Java_Sitemap
 . Generator

 . XmlBuilder

 . RangeMap

 . StringFormatter

 . VersionSafe
 . XCopy

 . JTextField

 . CommandLine-
 . ParamReader

 . Bitmap-Grafik

 . MultiMarkable-
 . Buffered-
 . InputStream

 . JavaCache

 . JdomUtil

 . CollectionUtil

 . XML Really
 . Pull Parser

 . Log-Filter

 . Remote-Protokoll

 . Sudoku-Generator

 . Delegation statt
 . Mehrfachvererbung

 . Disjunct
 . Interval Set

 . Constraint Class

 . Code Generator

Alaska-XBase++-Seite

Projekte

Philosophien
Techniken


Konzepte

Sudoku

Kontakt /
Impressum


Links

SiteMap





Letzte Aktualisierung:
23.11.2005
Multi Markable Buffered InputStream

Der BufferedInputStream aus dem JDK erlaubt das Setzen einer Markierung an der aktuellen Position und das Zurückkehren zur markierten Position. Aber das ist nur mit einer Position gleichzeitig möglich.

Die Java-Klasse MultiMarkableBufferedInputStream erlaubt das Setzen beliebig vieler Markierungen.

Dies ist notwendig für die Benutzung in einem XML-Parser, um einen Blick nach vorn (look ahead) zum Beispiel um festzustellen, ob jetzt ein Element ( < ) oder ein Kommentar (<!-- ) beginnt.

Ein Problem bei der Realisierung dieser Klasse war der zu verwendende Puffer. Ein Puffer konstanter Grösse müsste für den maximalen Abstand zwischen den Markierungen aufgerundet auf die Lese-Block-Grösse ausgelegt werden und würde sehr viel Speicher beanspruchen. Der maximale Abstand zwischen erster Markierung und dem Pufferende müsste bekannt sein.

Ein dynamisches Anpassen des Puffers (Byte-Array) würde das Umkopieren aller Daten vom alten Puffer in den neu allokierten Puffer erfordern, was zum Stocken des aufrufenden Programmes führen würde und allgemein inperformant ist. Im Moment des Umkopierens würde der Speicherplatz für beide Puffer benötigt werden.

Als Lösung dieser Probleme ist mir folgender Aufbau des Puffers aus einer einfach verlinkten Liste eingefallen.

Beim Einlesen des dekorierten java.io.InputStream wird jeweils ein Byte Array in der jeweiligen Puffer-Grösse angelegt.

Mehrere Puffer sind als einfach verlinkte Liste verbunden.

Nun bestetht das Problem, dass alte Puffer freigegeben werden müssen, um den Speicher freizubekommen (garbage collection).

Der MultiMarkableBufferedInputStream hat eine Referenz auf den jeweils aktuellen Puffer, welcher eine Referenz auf den nachfolgenden Puffer hat.

Falls beim Lesen das Pufferende erreicht wird, legt diese Java-Klasse einen NachfolgePuffer an, befüllt diesen und entnimmt aus diesem die zu lesenden Bytes.

Der neue Puffer wird der aktuelle Puffer und der Vorgängerpuffer wird nicht mehr referenziert. Damit kann er vom Garbage Collector entsorgt werden.

Falls das aufrufende Java-Programm eine Markierung setzen will, bekommt es ein Markierungs-Objekt mit der Referenz auf den jeweiligen Puffer und die Position im Puffer. Dadurch bleibt der markierte Puffer referenziert und kann nicht vom Garbage Collector entsorgt werden. Dieser Puffer hat wiederum eine Referenz auf eventuelle Nachfolge-Puffer.

Durch den Link auf den Nachfolgepuffer werden alle nachfolgenden Puffer, egal wie viele, mit referenziert und können nicht vom Garbage Collector entsorgt werden.

Wenn das aufrufende Java-Programm zu einer Markierung zurückkehren will, ruft es die resetMark(Mark)-Methode mit dem Mark-Objekt auf. Dies setzt den übergebenen (markierten) Puffer als aktuellen Puffer mitsamt aller Nachfolgepuffer und aktualisiert die Position.

Wenn das aufrufende Java-Programm ein Mark-Objekt löscht (die Referenz) oder es aus dem Scope fällt, kann der Garbage Collector den damit verbundenen Puffer und alle Nachfolge-Puffer entsorgen, die nicht von anderen Mark-Objekten oder im jeweiligen MultiMarkableBufferedInputStream-Objekt referenziert werden.

Dadurch wird erreicht,

dass es beliebig viele Markierungen geben kann, deren Puffer und eventuellen Nachfolge-Puffer solange wie notwendig referenziert werden,

dass beliebig weit voraus gelesen werden kann (look ahead),

dass nicht mehr benötigte Puffer dereferenziert werden und somit vom Garbage Collector entsorgt werden können.


Mark --------> Puffer Byte Array, Position
                nextEntry
                 |
                 +------> Puffer Byte Array, Position
                           nextEntry
                            |
                            +------> Puffer Byte Array, Position
                                      nextEntry
                                       |
currentBuffListEntry ----------------> +------> Puffer Byte Array, Position
                                                 nextEntry
                                                  |
                                                  +------> Puffer Byte Array, Position
                                                            nextEntry


Siehe hierzu auch DomainParser



Download der Java-Quelldateien MultiMarkableBufferedInputStream.zip

Achtung: Erweiterungen und Fixes stelle ich ohne Historie und ohne Ankündigung hier bereit.
Deshalb am besten immer die letzte Version runterladen.

Lizenzbedingungen:

Die Programme, Quelltexte und Dokumentationen können ohne irgendwelche Bedingungen kostenlos verwendet werden.
Sie sind Freeware und Open Source. Für Fehler und Folgen wird keinerlei Haftung übernommen.

Hinweise zur Fehlerbeseitigung und Verbesserung sind mir willkommen.

Ich freue mich auch über Feedback bezüglich der erfolgreichen Verwendung meiner Sourcen.

Bei Fragen helfe ich gern mit Hinweisen oder zusätzlicher Dokumentation, falls ich dafür Zeit habe.