fr.inria.atlanmod.neoemf.io.persistence

Class AbstractPersistenceHandler<P extends PersistenceBackend>

java.lang.Object

fr.inria.atlanmod.neoemf.io.persistence.AbstractPersistenceHandler<P>

Type Parameters:

P - the type of the PersistenceBackend targeted by this handler.

All Implemented Interfaces:

InputHandler, PersistenceHandler

Direct Known Subclasses:

AbstractBlueprintsHandler

public abstract class AbstractPersistenceHandler<P extends PersistenceBackend>
extends Object
implements PersistenceHandler

A PersistenceHandler that persists data in a PersistenceBackend, based on received events.

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	DEFAULT_CACHE_SIZE The default cache size.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPersistenceHandler(P backend) Constructs a new AbstractPersistenceHandler on top of the backend.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addAttribute(Id id, String name, int index, boolean many, Object value) Adds a new attribute to the element identified by the given id.
protected abstract void	addElement(Id id, String nsUri, String name, boolean root) Adds a new element.
protected abstract void	addReference(Id id, String name, int index, boolean many, boolean containment, Id idReference) Adds a new reference to the element identified by the given id.
protected Id	createElement(Classifier classifier, Id id) Creates an element from the given classifier with the given id.
protected abstract Id	getId(String reference) Returns the Id of the given reference.
protected Id	getOrCreateMetaClass(MetaClassifier metaClassifier) Creates a metaclass form the given metaClassifier and returns its Id.
protected P	getPersistenceBackend() Returns the backend where to store data.
void	processAttribute(Attribute attribute) Process an attribute in the current element.
void	processCharacters(String characters) Process a set of characters.
void	processEndDocument() Process the end of a document.
void	processEndElement() Process the end of the current element.
void	processReference(Reference reference) Process a reference from the current element to another element.
void	processStartDocument() Process the start of a document.
void	processStartElement(Classifier classifier) Process the start of an element.
protected abstract void	setMetaClass(Id id, Id metaClassId) Defines the metaclass to the element identified by the given id.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHE_SIZE

protected static final long DEFAULT_CACHE_SIZE

The default cache size.

It is calculated according to the maximum memory dedicated to the JVM.

Constructor Detail

AbstractPersistenceHandler

protected AbstractPersistenceHandler(P backend)

Constructs a new AbstractPersistenceHandler on top of the backend.

Parameters:

backend - the persistence back-end where to store data

Method Detail

getPersistenceBackend

protected P getPersistenceBackend()

Returns the backend where to store data.

Returns:

the persistence back-end

getId

protected abstract Id getId(String reference)

Returns the Id of the given reference.

Parameters:

reference - the reference

Returns:

the Id

addElement

protected abstract void addElement(Id id,
                                   String nsUri,
                                   String name,
                                   boolean root)

Adds a new element.

Parameters:

id - the identifier of the new element

nsUri - the URI of the new element

name - the name of the new element

root - true if the new element is a root node

addAttribute

protected abstract void addAttribute(Id id,
                                     String name,
                                     int index,
                                     boolean many,
                                     Object value)

Adds a new attribute to the element identified by the given id.

Parameters:

id - the identifier of the element

name - the name of the attribute

index - the index of the attribute if it's a multi-valued attribute

many - true if the attribute is multi-valued

value - the value of the attribute

addReference

protected abstract void addReference(Id id,
                                     String name,
                                     int index,
                                     boolean many,
                                     boolean containment,
                                     Id idReference)

Adds a new reference to the element identified by the given id.

Parameters:

id - the identifier of the element

name - the name of the reference

index - the index of the reference if it's a multi-valued reference

many - true if the reference is multi-valued

containment - true if the reference is a containment

idReference - the identifier of the referenced element

setMetaClass

protected abstract void setMetaClass(Id id,
                                     Id metaClassId)

Defines the metaclass to the element identified by the given id.

Parameters:

id - the identifier of the element

metaClassId - the identifier of the metaclass

processStartDocument

public void processStartDocument()

Description copied from interface: InputHandler

Process the start of a document.

Specified by:

processStartDocument in interface InputHandler

See Also:

InputNotifier.notifyStartDocument()

processStartElement

public void processStartElement(Classifier classifier)

Description copied from interface: InputHandler

Process the start of an element.

Specified by:

processStartElement in interface InputHandler

Parameters:

classifier - the classifier of the new element

See Also:

InputNotifier.notifyStartElement(Classifier)

processAttribute

public void processAttribute(Attribute attribute)

Description copied from interface: InputHandler

Process an attribute in the current element.

An attribute is a simple key/value.

Specified by:

processAttribute in interface InputHandler

Parameters:

attribute - the new attribute

See Also:

InputNotifier.notifyAttribute(Attribute)

processReference

public void processReference(Reference reference)

Description copied from interface: InputHandler

Process a reference from the current element to another element.

A reference is an attribute which is link to another element.

Specified by:

processReference in interface InputHandler

Parameters:

reference - the new reference

See Also:

InputNotifier.notifyReference(Reference)

processEndElement

public void processEndElement()

Description copied from interface: InputHandler

Process the end of the current element.

Specified by:

processEndElement in interface InputHandler

See Also:

InputNotifier.notifyEndElement()

processEndDocument

public void processEndDocument()

Description copied from interface: InputHandler

Process the end of a document.

Specified by:

processEndDocument in interface InputHandler

See Also:

InputNotifier.notifyEndDocument()

processCharacters

public void processCharacters(String characters)

Description copied from interface: InputHandler

Process a set of characters.

Specified by:

processCharacters in interface InputHandler

Parameters:

characters - the new characters

See Also:

InputNotifier.notifyCharacters(String)

createElement

protected Id createElement(@Nonnull
                           Classifier classifier,
                           @Nonnull
                           Id id)

Creates an element from the given classifier with the given id.

If id is null, it is calculated by the getId(String) method.

Parameters:

classifier - the information about the new element

id - the identifier of the element

Returns:

the given id

Throws:

NullPointerException - if any of the parameters is null

getOrCreateMetaClass

protected Id getOrCreateMetaClass(@Nonnull
                                  MetaClassifier metaClassifier)

Creates a metaclass form the given metaClassifier and returns its Id.

Parameters:

metaClassifier - the meta classifier

Returns:

the Id of the created metaclass

Throws:

NullPointerException - if the metaClassifier is null