fr.inria.atlanmod.neoemf.io.reader

Class AbstractStreamReader

java.lang.Object

fr.inria.atlanmod.neoemf.io.AbstractNotifier<Processor>

fr.inria.atlanmod.neoemf.io.reader.AbstractReader<InputStream>

fr.inria.atlanmod.neoemf.io.reader.AbstractStreamReader

All Implemented Interfaces:

Notifier, Reader<InputStream>

Direct Known Subclasses:

AbstractXmiStreamReader

@ParametersAreNonnullByDefault
public abstract class AbstractStreamReader
extends AbstractReader<InputStream>

An abstract Reader that reads data from an InputStream.

Constructor Summary

Constructors

Constructor and Description
AbstractStreamReader()

Method Summary

Modifier and Type	Method and Description
protected void	flushCurrentElement() Finalizes the current element and sends all delayed notifications to handlers.
ProxyElement	getCurrentElement() Returns the current element.
Id	getPreviousId() Returns the identifier of the previous element.
void	ignoreCurrentElement() Asks to ignore the current element.
protected abstract boolean	isSpecialAttribute(String prefix, String name, String value) Defines if the attribute represented with the parameters is a special attribute as 'xsi:type', 'xmi:id' or 'xmi:idref'.
abstract void	parse(InputStream stream) Parses the content of the stream.
void	read(InputStream source) Reads an Object.
protected void	readAttribute(String prefix, String name, String value) Reads a new attribute of the current element.
protected void	readEndDocument() Reads the end of the current document.
protected void	readEndElement() Reads the end of an element.
protected void	readMetaClass(String prefixedValue) Reads a meta-class attribute from the prefixedValue, and defines is as the meta-class of the given element.
protected void	readNamespace(String prefix, String uri) Reads a ProxyPackage declaration.
protected void	readSimpleElement(String uri, String name, String value) Reads a new simple element, as <name>value</name>.
protected void	readStartDocument() Reads the start of the document.
protected void	readStartElement(String uri, String name) Reads the start of a new element.

Methods inherited from class fr.inria.atlanmod.neoemf.io.reader.AbstractReader

addNext, createProcessors

Methods inherited from class fr.inria.atlanmod.neoemf.io.AbstractNotifier

addNext, notifyAttribute, notifyComplete, notifyEndElement, notifyInitialize, notifyReference, notifyStartElement, supportsMultiTargets

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.Notifier

notifyAttribute, notifyComplete, notifyEndElement, notifyInitialize, notifyReference, notifyStartElement

Constructor Detail

AbstractStreamReader

public AbstractStreamReader()

Method Detail

read

public final void read(InputStream source)
                throws IOException

Description copied from interface: Reader

Reads an Object.

Parameters:

source - the object to read

Throws:

IOException - if an error occurred during the I/O process

parse

public abstract void parse(InputStream stream)
                    throws IOException

Parses the content of the stream.

Parameters:

stream - the stream to read

Throws:

IOException - if an error occurred during the I/O process

getPreviousId

@Nonnull
public Id getPreviousId()

Returns the identifier of the previous element.

Returns:

the identifier of the previous element

getCurrentElement

@Nonnull
public ProxyElement getCurrentElement()

Returns the current element.

Returns:

the current element (mutable)

ignoreCurrentElement

public void ignoreCurrentElement()

Asks to ignore the current element. If an element is ignored, the element and its content will no be notified to next handlers.

readStartDocument

protected final void readStartDocument()
                                throws IOException

Reads the start of the document.

Throws:

IOException

readStartElement

protected final void readStartElement(@Nullable
                                      String uri,
                                      String name)

Reads the start of a new element.

Note: An element must be flushed with the flushCurrentElement() method after analysing all its attributes.

Parameters:

uri - the namespace's URI of the element

name - the name of the element

readSimpleElement

protected final void readSimpleElement(@Nullable
                                       String uri,
                                       String name,
                                       String value)
                                throws IOException

Reads a new simple element, as <name>value</name>.

Parameters:

uri - the namespace's URI of the element

name - the name of the element

value - the literal value of the element

Throws:

IOException

readNamespace

protected final void readNamespace(String prefix,
                                   String uri)

Reads a ProxyPackage declaration.

Parameters:

prefix - the prefix of the namespace

uri - the URI of the namespace

See Also:

ProxyPackage.Registry#register(String, String)

flushCurrentElement

protected final void flushCurrentElement()
                                  throws IOException

Finalizes the current element and sends all delayed notifications to handlers.

Throws:

IOException

readAttribute

protected final void readAttribute(@Nullable
                                   String prefix,
                                   String name,
                                   String value)
                            throws IOException

Reads a new attribute of the current element.

Parameters:

prefix - the namespace's prefix of the attribute

name - the name of the attribute

value - the value of the attribute

Throws:

IOException

readMetaClass

protected final void readMetaClass(String prefixedValue)

Reads a meta-class attribute from the prefixedValue, and defines is as the meta-class of the given element.

Parameters:

prefixedValue - the value representing the meta-class

See Also:

PATTERN_PREFIXED_VALUE

readEndElement

protected final void readEndElement()
                             throws IOException

Reads the end of an element.

Throws:

IOException

readEndDocument

protected final void readEndDocument()
                              throws IOException

Reads the end of the current document.

Throws:

IOException

isSpecialAttribute

protected abstract boolean isSpecialAttribute(@Nullable
                                              String prefix,
                                              String name,
                                              String value)
                                       throws IOException

Defines if the attribute represented with the parameters is a special attribute as 'xsi:type', 'xmi:id' or 'xmi:idref'.

Parameters:

prefix - the namespace's prefix of the attribute

name - the name of the attribute

value - the value of the attribute

Returns:

true if the given feature is a special feature

Throws:

IOException