Package com.tagtraum.core

Class XmlDB<T>

java.lang.Object

com.tagtraum.core.XmlDB<T>

Type Parameters:

T - type of the list elements

public class XmlDB<T>
extends Object

XMLDB, simple, XML file based storage facility using the standard XMLEncoder/XMLDecoder serialization mechanism.

Author:

Hendrik Schreiber

Constructor Summary

Constructors

Constructor	Description
XmlDB(File file)
XmlDB(File file, boolean compress, Cipher cipher, Key key)
XmlDB(URL url)	URL backed read-only XmlDB.
XmlDB(URL url, boolean compress, Cipher cipher, Key key)	URL backed read-only XmlDB.

Method Summary

Modifier and Type	Method	Description
void	addRegexReplacement(String regex, String replacement)
File	getFile()
Object	getSource()	Source, i.e.
URL	getUrl()
Iterator<T>	iterator()	Iterator over the XMLDB file.
Collection<T>	read()
void	read(Collection<T> targetCollection)
void	setProgressListener(ProgressListener progressListener)
void	write(Iterable<T> iterable, int size)
void	write(Iterable<T> iterable, int size, int batchSize)
void	write(Collection<T> collection)

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDB

public XmlDB(File file,
             boolean compress,
             Cipher cipher,
             Key key)

Parameters:

file - data file

compress - compress data

XmlDB

public XmlDB(File file)

Parameters:

file - data file

XmlDB

public XmlDB(URL url,
             boolean compress,
             Cipher cipher,
             Key key)

URL backed read-only XmlDB.

Parameters:

url - data url

compress - compress data

XmlDB

public XmlDB(URL url)

URL backed read-only XmlDB.

Parameters:

url - data file

Method Detail

addRegexReplacement

public void addRegexReplacement(String regex,
                                String replacement)

getFile

public File getFile()

getUrl

public URL getUrl()

getSource

public Object getSource()

Source, i.e. either File or URL.

Returns:

file or url.

read

public Collection<T> read()
                   throws IOException

Returns:

a parametrized collection

Throws:

IOException

read

public void read(Collection<T> targetCollection)
          throws IOException

Parameters:

targetCollection - collection to put the data into

Throws:

IOException

iterator

public Iterator<T> iterator()
                     throws IOException

Iterator over the XMLDB file.

Throws:

IOException

write

public void write(Collection<T> collection)
           throws IOException

Parameters:

collection - collection to write

Throws:

IOException

write

public void write(Iterable<T> iterable,
                  int size)
           throws IOException

Parameters:

iterable - iterable

size - size

Throws:

IOException

write

public void write(Iterable<T> iterable,
                  int size,
                  int batchSize)
           throws IOException

Parameters:

iterable - iterable

size - size

batchSize - batch size

Throws:

IOException

setProgressListener

public void setProgressListener(ProgressListener progressListener)