fr.inria.atlanmod.neoemf.io

Class Migrator<T>

java.lang.Object

fr.inria.atlanmod.neoemf.io.Migrator<T>

@ParametersAreNonnullByDefault
public final class Migrator<T>
extends Object

The builder that creates Reader and Writer instances.

Method Summary

Modifier and Type	Method and Description
static Migrator<DataMapper>	fromMapper(DataMapper mapper) Creates a Migrator that reads a DataMapper.
static Migrator<InputStream>	fromXmi(File file) Creates a Migrator that reads a XMI file.
static Migrator<InputStream>	fromXmi(InputStream stream) Creates a Migrator that reads XMI content from an InputStream.
void	migrate() Runs the migration.
Migrator<T>	toMapper(DataMapper mapper) Specifies the mapper where to write the data.
Migrator<T>	toXmi(File file) Specifies the XMI file where to write the data.
Migrator<T>	toXmi(File file, boolean useCompression) Specifies the XMI file where to write the data.
Migrator<T>	toXmi(OutputStream stream) Specifies the stream where to write the data.
Migrator<T>	with(EventListener listener) Adds a pre/post-processing feature.
Migrator<T>	withCounter() Counts the number of processed events (elements, attributes, references).
Migrator<T>	withLogger() Logs each event when they occur.
Migrator<T>	withLogger(Level level) Logs each event when they occur.
Migrator<T>	withProgress() Displays the progress of the migration at regular intervals.
Migrator<T>	withTimer() Displays the amount of time spent during the migration.

Methods inherited from class java.lang.Object

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

Method Detail

fromXmi

@Nonnull
public static Migrator<InputStream> fromXmi(File file)
                                               throws IOException

Creates a Migrator that reads a XMI file. The file can be compressed.

Parameters:

file - the XMI file to read

Returns:

a new migrator

Throws:

IOException - if an I/O error occurs during the creation

fromXmi

@Nonnull
public static Migrator<InputStream> fromXmi(InputStream stream)
                                               throws IOException

Creates a Migrator that reads XMI content from an InputStream. The content can be compressed.

Parameters:

stream - the stream of the XMI content to read

Returns:

a new migrator

Throws:

IOException - if an I/O error occurs during the creation

fromMapper

@Nonnull
public static Migrator<DataMapper> fromMapper(DataMapper mapper)

Creates a Migrator that reads a DataMapper.

Parameters:

mapper - the mapper to read

Returns:

a new migrator

toMapper

@Nonnull
public Migrator<T> toMapper(DataMapper mapper)

Specifies the mapper where to write the data.

Parameters:

mapper - the mapper where to write

Returns:

this migrator (for chaining)

toXmi

@Nonnull
public Migrator<T> toXmi(File file)
                            throws IOException

Specifies the XMI file where to write the data.

Parameters:

file - the file where to write

Returns:

this migrator (for chaining)

Throws:

IOException - if an I/O error occurs during the creation

See Also:

toXmi(File, boolean)

toXmi

@Nonnull
public Migrator<T> toXmi(File file,
                                   boolean useCompression)
                            throws IOException

Specifies the XMI file where to write the data.

Parameters:

file - the file where to write

useCompression - true if the XMI file must be compressed

Returns:

this migrator (for chaining)

Throws:

IOException - if an I/O error occurs during the creation

toXmi

@Nonnull
public Migrator<T> toXmi(@WillNotClose
                                   OutputStream stream)
                            throws IOException

Specifies the stream where to write the data.

Parameters:

stream - the file where to write

Returns:

this migrator (for chaining)

Throws:

IOException - if an I/O error occurs when writing

with

@Nonnull
public Migrator<T> with(EventListener listener)

Adds a pre/post-processing feature.

Parameters:

listener - the listener to add

Returns:

this migrator (for chaining)

withLogger

@Nonnull
public Migrator<T> withLogger()

Logs each event when they occur.

Returns:

this migrator (for chaining)

withLogger

@Nonnull
public Migrator<T> withLogger(Level level)

Logs each event when they occur.

Parameters:

level - the logging level to use

Returns:

this migrator (for chaining)

withCounter

@Nonnull
public Migrator<T> withCounter()

Counts the number of processed events (elements, attributes, references).

Returns:

this migrator (for chaining)

withTimer

@Nonnull
public Migrator<T> withTimer()

Displays the amount of time spent during the migration.

Returns:

this migrator (for chaining)

withProgress

@Nonnull
public Migrator<T> withProgress()

Displays the progress of the migration at regular intervals.

WARNING: This feature can only be used when reading a file or a stream.

Returns:

this migrator (for chaining)

migrate

public void migrate()
             throws IOException

Runs the migration.

Throws:

IOException - if an I/O error occurs when migrating