fr.inria.atlanmod.neoemf.data.blueprints.io

Class AbstractBlueprintsHandler

java.lang.Object

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

fr.inria.atlanmod.neoemf.data.blueprints.io.AbstractBlueprintsHandler

All Implemented Interfaces:

InputHandler, PersistenceHandler

Direct Known Subclasses:

BlueprintsAwareHandler, BlueprintsNaiveHandler

public abstract class AbstractBlueprintsHandler
extends AbstractPersistenceHandler<BlueprintsPersistenceBackend>

An abstract PersistenceHandler specific to a Blueprints implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.github.benmanes.caffeine.cache.Cache<Id,Vertex>	verticesCache In-memory cache that holds recently processed Vertexs, identified by the associated object Id.

Fields inherited from class fr.inria.atlanmod.neoemf.io.persistence.AbstractPersistenceHandler

DEFAULT_CACHE_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractBlueprintsHandler(BlueprintsPersistenceBackend backend) Constructs a new AbstractBlueprintsHandler on the given backend.

Method Summary

Modifier and Type	Method and Description
protected 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 void	addElement(Id id, String nsUri, String name, boolean root) Adds a new element.
protected 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 abstract Vertex	createVertex(Id id) Creates a Vertex identified by the specified id.
protected Id	getId(String reference) Returns the Id of the given reference.
protected abstract Vertex	getVertex(Id id) Returns the Vertex which has the specified id.
void	processStartDocument() Process the start of a document.
protected void	setMetaClass(Id id, Id metaClassId) Defines the metaclass to the element identified by the given id.

Methods inherited from class fr.inria.atlanmod.neoemf.io.persistence.AbstractPersistenceHandler

createElement, getOrCreateMetaClass, getPersistenceBackend, processAttribute, processCharacters, processEndDocument, processEndElement, processReference, processStartElement

Methods inherited from class java.lang.Object

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

Field Detail

verticesCache

protected final com.github.benmanes.caffeine.cache.Cache<Id,Vertex> verticesCache

In-memory cache that holds recently processed Vertexs, identified by the associated object Id.

Constructor Detail

AbstractBlueprintsHandler

public AbstractBlueprintsHandler(BlueprintsPersistenceBackend backend)

Constructs a new AbstractBlueprintsHandler on the given backend.

Parameters:

backend - the back-end where to store data

Method Detail

getId

protected Id getId(String reference)

Description copied from class: AbstractPersistenceHandler

Returns the Id of the given reference.

Specified by:

getId in class AbstractPersistenceHandler<BlueprintsPersistenceBackend>

Parameters:

reference - the reference

Returns:

the Id

addElement

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

Description copied from class: AbstractPersistenceHandler

Adds a new element.

Specified by:

addElement in class AbstractPersistenceHandler<BlueprintsPersistenceBackend>

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 void addAttribute(Id id,
                            String name,
                            int index,
                            boolean many,
                            Object value)

Description copied from class: AbstractPersistenceHandler

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

Specified by:

addAttribute in class AbstractPersistenceHandler<BlueprintsPersistenceBackend>

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 void addReference(Id id,
                            String name,
                            int index,
                            boolean many,
                            boolean containment,
                            Id idReference)

Description copied from class: AbstractPersistenceHandler

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

Specified by:

addReference in class AbstractPersistenceHandler<BlueprintsPersistenceBackend>

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 void setMetaClass(Id id,
                            Id metaClassId)

Description copied from class: AbstractPersistenceHandler

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

Specified by:

setMetaClass in class AbstractPersistenceHandler<BlueprintsPersistenceBackend>

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

Overrides:

processStartDocument in class AbstractPersistenceHandler<BlueprintsPersistenceBackend>

See Also:

InputNotifier.notifyStartDocument()

getVertex

protected abstract Vertex getVertex(Id id)

Returns the Vertex which has the specified id.

Parameters:

id - the identifier of the vertex

Returns:

the Vertex

Throws:

NoSuchElementException - if no element is found with the id

createVertex

protected abstract Vertex createVertex(Id id)

Creates a Vertex identified by the specified id.

Parameters:

id - the identifier of the vertex

Returns:

the new Vertex

Throws:

AlreadyExistingIdException - if the id is already used as primary key for another element