fr.inria.atlanmod.neoemf.io.writer

Class AbstractXmiStreamWriter

java.lang.Object

fr.inria.atlanmod.neoemf.io.writer.AbstractWriter<OutputStream>

fr.inria.atlanmod.neoemf.io.writer.AbstractStreamWriter

fr.inria.atlanmod.neoemf.io.writer.AbstractXmiStreamWriter

All Implemented Interfaces:

Handler, Writer

Direct Known Subclasses:

XmiStreamWriter

@ParametersAreNonnullByDefault
public abstract class AbstractXmiStreamWriter
extends AbstractStreamWriter

An AbstractStreamWriter that writes data into an XMI file.

Field Summary

Fields inherited from class fr.inria.atlanmod.neoemf.io.writer.AbstractWriter

target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractXmiStreamWriter(OutputStream stream) Constructs a new AbstractXmiStreamWriter with the given stream.

Method Summary

Modifier and Type	Method and Description
void	onAttribute(ProxyAttribute attribute, List<Object> values) Handles an attribute in the current element.
void	onComplete() Handles the end of the current task.
void	onEndElement() Handles the end of the current element.
void	onInitialize() Handles the start of a task.
void	onReference(ProxyReference reference, List<Id> values) Handles a reference in the current element.
void	onStartElement(ProxyElement element) Handles the start of an element.
protected abstract void	writeAttribute(String name, String value) Writes an attribute of the current element.
protected abstract void	writeCharacters(String characters) Writes characters.
protected abstract void	writeEndDocument() Writes the end of the document and finalizes the migration.
protected abstract void	writeEndElement() Writes the end of the current element.
protected abstract void	writeNamespace(String prefix, String uri) Writes a namespace.
protected abstract void	writeStartDocument() Writes the start of a document, including the general header.
protected abstract void	writeStartElement(String name) Writes the start of an element name

Methods inherited from class fr.inria.atlanmod.neoemf.io.writer.AbstractStreamWriter

requireEndBeforeFlush

Methods inherited from class fr.inria.atlanmod.neoemf.io.writer.AbstractWriter

onAttribute, onReference

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmiStreamWriter

protected AbstractXmiStreamWriter(OutputStream stream)

Constructs a new AbstractXmiStreamWriter with the given stream.

Parameters:

stream - the stream where to write data

Method Detail

onInitialize

public final void onInitialize()
                        throws IOException

Description copied from interface: Handler

Handles the start of a task.

Throws:

IOException

See Also:

Handler.onComplete(), Notifier.notifyInitialize()

onComplete

public final void onComplete()
                      throws IOException

Description copied from interface: Handler

Handles the end of the current task.

Throws:

IOException

See Also:

Handler.onInitialize(), Notifier.notifyComplete()

onStartElement

public final void onStartElement(ProxyElement element)
                          throws IOException

Description copied from interface: Handler

Handles the start of an element.

Specified by:

onStartElement in interface Handler

Overrides:

onStartElement in class AbstractWriter<OutputStream>

Parameters:

element - the element of the new element

Throws:

IOException

See Also:

Handler.onEndElement(), Notifier.notifyStartElement(ProxyElement)

onEndElement

public final void onEndElement()
                        throws IOException

Description copied from interface: Handler

Handles the end of the current element.

Specified by:

onEndElement in interface Handler

Overrides:

onEndElement in class AbstractWriter<OutputStream>

Throws:

IOException

See Also:

Handler.onStartElement(ProxyElement), Notifier.notifyEndElement()

onAttribute

public final void onAttribute(ProxyAttribute attribute,
                              List<Object> values)
                       throws IOException

Description copied from class: AbstractWriter

Handles an attribute in the current element.

Specified by:

onAttribute in class AbstractWriter<OutputStream>

Parameters:

attribute - the new attribute, without its value

values - the ordered values of the attribute; when the attribute is single-valued, this parameter is a Collections.singletonList(Object)

Throws:

IOException

onReference

public final void onReference(ProxyReference reference,
                              List<Id> values)
                       throws IOException

Description copied from class: AbstractWriter

Handles a reference in the current element.

Specified by:

onReference in class AbstractWriter<OutputStream>

Parameters:

reference - the new reference, without its value

values - the ordered values of the reference; when the reference is single-valued, this parameter is a Collections.singletonList(Object)

Throws:

IOException

writeStartDocument

protected abstract void writeStartDocument()
                                    throws IOException

Writes the start of a document, including the general header.

Throws:

IOException - if an I/O error occurs when writing

writeStartElement

protected abstract void writeStartElement(String name)
                                   throws IOException

Writes the start of an element name

Parameters:

name - the name of the element

Throws:

IOException - if an I/O error occurs when writing

writeNamespace

protected abstract void writeNamespace(String prefix,
                                       String uri)
                                throws IOException

Writes a namespace.

Parameters:

prefix - the prefix of the namespace

uri - the URI of the namespace

Throws:

IOException - if an I/O error occurs when writing

writeAttribute

protected abstract void writeAttribute(String name,
                                       String value)
                                throws IOException

Writes an attribute of the current element.

Parameters:

name - the name of the attribute

value - the value of the attribute

Throws:

IOException - if an I/O error occurs when writing

writeCharacters

protected abstract void writeCharacters(String characters)
                                 throws IOException

Writes characters.

Parameters:

characters - the characters

Throws:

IOException - if an I/O error occurs when writing

writeEndElement

protected abstract void writeEndElement()
                                 throws IOException

Writes the end of the current element.

Throws:

IOException - if an I/O error occurs when writing

writeEndDocument

protected abstract void writeEndDocument()
                                  throws IOException

Writes the end of the document and finalizes the migration.

Throws:

IOException - if an I/O error occurs when writing