com.googlecode.n_orm.operations

Class ImportExport

java.lang.Object

com.googlecode.n_orm.operations.ImportExport

public class ImportExport
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportExport.ExportReport
static class	ImportExport.ProcessReadException An exception rose during a deserialization process.
static class	ImportExport.ReadException The list of exception raised during a read process.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZATION_SEPARATOR

Method Summary

Modifier and Type	Method and Description
static ImportExport.ExportReport	exportPersistingElements(CloseableIterator<? extends PersistingElement> elementsIterator, ObjectOutputStream out) Serialize a binary representation for elements in an OutputStream.
static long	importPersistingElements(InputStream fis) Import a serialized set in a InputStream.
static long	importPersistingElements(String file) Import a serialized set from a file.
static <T extends PersistingElement> long	readSerializedPersistingElements(InputStream fis, Process<T> process) Processes sequentially each element of a serialized stream without importing them.
static long	readSerializedPersistingElements(String file, Process<? extends PersistingElement> process) Processes sequentially each element of a serialized file without importing them.

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZATION_SEPARATOR

public static final String SERIALIZATION_SEPARATOR

See Also:

Constant Field Values

Method Detail

exportPersistingElements

public static ImportExport.ExportReport exportPersistingElements(CloseableIterator<? extends PersistingElement> elementsIterator,
                                                                 ObjectOutputStream out)
                                                          throws IOException

Serialize a binary representation for elements in an OutputStream. Dependencies are not serialized. Elements are removed from cache to avoid memory consumption.

Parameters:

elementsIterator - an iterator over the elements to be serialized ; closed by the method

Returns:

lastElement the last element serialized from the collection

Throws:

IOException

importPersistingElements

public static long importPersistingElements(InputStream fis)
                                     throws DatabaseNotReachedException,
                                            IOException,
                                            ClassNotFoundException,
                                            ImportExport.ReadException

Import a serialized set in a InputStream. Each element is loaded with data found from the input stream and stored. Elements are removed from cache to avoid memory consumption.

Parameters:

fis - the input stream to import from ; must support InputStream.markSupported()

Returns:

the number of imported elements

Throws:

DatabaseNotReachedException

IOException

ClassNotFoundException

ImportExport.ReadException

readSerializedPersistingElements

public static <T extends PersistingElement> long readSerializedPersistingElements(InputStream fis,
                                                                                  Process<T> process)
                                                                           throws DatabaseNotReachedException,
                                                                                  IOException,
                                                                                  ClassNotFoundException,
                                                                                  ImportExport.ReadException

Processes sequentially each element of a serialized stream without importing them. Each element is removed from cache as soon as it is processed so as to avoid memory consumption.

Parameters:

fis - the input stream of elements

process - the process to be applied to each element

Returns:

the number of processed elements, including those that rose an error

Throws:

ImportExport.ReadException - errors while processing elements

DatabaseNotReachedException

IOException

ClassNotFoundException

importPersistingElements

public static long importPersistingElements(String file)
                                     throws DatabaseNotReachedException,
                                            IOException,
                                            ClassNotFoundException,
                                            ImportExport.ReadException

Import a serialized set from a file. Each element is loaded with data found from the file and stored. Elements are removed from cache to avoid memory consumption.

Parameters:

file - the file to import from

Returns:

the number of imported elements

Throws:

DatabaseNotReachedException

IOException

ClassNotFoundException

ImportExport.ReadException

readSerializedPersistingElements

public static long readSerializedPersistingElements(String file,
                                                    Process<? extends PersistingElement> process)
                                             throws DatabaseNotReachedException,
                                                    IOException,
                                                    ClassNotFoundException,
                                                    ImportExport.ReadException

Processes sequentially each element of a serialized file without importing them. Each element is removed from cache as soon as it is processed so as to avoid memory consumption.

Parameters:

file - the file to import from

process - the process to be applied to each element

Returns:

the number of processed elements, including those that rose an error

Throws:

ImportExport.ReadException - errors while processing elements

DatabaseNotReachedException

IOException

ClassNotFoundException