fr.inria.atlanmod.neoemf.io.writer

Class AbstractWriter<T>

java.lang.Object

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

Type Parameters:

T - the type of the target

All Implemented Interfaces:

Handler, Writer

Direct Known Subclasses:

AbstractStreamWriter, DefaultMapperWriter

@ParametersAreNonnullByDefault
public abstract class AbstractWriter<T>
extends Object
implements Writer

An abstract Writer that acts as an accumulator of multi-value features in order to notify them once. This allow to use batch methods in a DataMapper, and ensure the call order when writing in a file.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	target The target where to write data.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWriter(T target) Constructs a new AbstractWriter with the given target.

Method Summary

Modifier and Type	Method and Description
void	onAttribute(ProxyAttribute attribute) Handles an attribute in the current element.
abstract void	onAttribute(ProxyAttribute attribute, List<Object> values) Handles an attribute in the current element.
void	onEndElement() Handles the end of the current element.
void	onReference(ProxyReference reference) Handles a reference from the current element to another.
abstract 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 boolean	requireEndBeforeFlush() Returns true if this writer requires the end of the current element before flushing all features, otherwise, all features will be flushed as soon as another feature is intercepted.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.inria.atlanmod.neoemf.io.Handler

onComplete, onInitialize

Field Detail

target

@Nonnull
protected final T target

The target where to write data.

Constructor Detail

AbstractWriter

protected AbstractWriter(T target)

Constructs a new AbstractWriter with the given target.

Parameters:

target - the target where to write data

Method Detail

onStartElement

@OverridingMethodsMustInvokeSuper
public void onStartElement(ProxyElement element)
                                                       throws IOException

Description copied from interface: Handler

Handles the start of an element.

Specified by:

onStartElement in interface Handler

Parameters:

element - the element of the new element

Throws:

IOException

See Also:

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

onAttribute

public final void onAttribute(ProxyAttribute attribute)
                       throws IOException

Description copied from interface: Handler

Handles an attribute in the current element.

Specified by:

onAttribute in interface Handler

Parameters:

attribute - the new attribute

Throws:

IOException

See Also:

Handler.onStartElement(ProxyElement), Notifier.notifyAttribute(ProxyAttribute)

onReference

public final void onReference(ProxyReference reference)
                       throws IOException

Description copied from interface: Handler

Handles a reference from the current element to another.

Specified by:

onReference in interface Handler

Parameters:

reference - the new reference

Throws:

IOException

See Also:

Handler.onStartElement(ProxyElement), Notifier.notifyReference(ProxyReference)

onEndElement

@OverridingMethodsMustInvokeSuper
public void onEndElement()
                                                     throws IOException

Description copied from interface: Handler

Handles the end of the current element.

Specified by:

onEndElement in interface Handler

Throws:

IOException

See Also:

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

onAttribute

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

Handles an attribute in the current element.

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 abstract void onReference(ProxyReference reference,
                                 List<Id> values)
                          throws IOException

Handles a reference in the current element.

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

requireEndBeforeFlush

protected boolean requireEndBeforeFlush()

Returns true if this writer requires the end of the current element before flushing all features, otherwise, all features will be flushed as soon as another feature is intercepted. This is typically used when writing a structured file with streams.

Returns:

true if this writer requires the end of the current element before flushing all features