diff --git a/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/core/DefaultPersistentEObject.java b/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/core/DefaultPersistentEObject.java index 206ab2b3b0..99096faadb 100644 --- a/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/core/DefaultPersistentEObject.java +++ b/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/core/DefaultPersistentEObject.java @@ -47,7 +47,7 @@ * This class extends {@link MinimalEStoreEObjectImpl} that delegates {@link EStructuralFeature} accesses * to an underlying {@link EStore} that interacts with the database used to store the model. *
- * {@link DefaultPersistentEObject}s is backend-agnostic, and is as an EMF-level element wrapper in all + * {@link DefaultPersistentEObject}s is backend-agnostic, and is as an EMF-level element wrapper in all * existing database implementations. */ public class DefaultPersistentEObject extends MinimalEStoreEObjectImpl implements PersistentEObject { diff --git a/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/resource/DefaultPersistentResource.java b/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/resource/DefaultPersistentResource.java index a36c4c02aa..8465c26727 100644 --- a/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/resource/DefaultPersistentResource.java +++ b/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/resource/DefaultPersistentResource.java @@ -58,8 +58,8 @@ /** * The default implementation of a {@link PersistentResource} that contains {@link PersistentEObject}. *
- * {@link DefaultPersistentResource}s is backend-agnostic and only delegates model element operations
- * to its internal {@link PersistentStore} which is reponsible of database access.
+ * {@link DefaultPersistentResource}s is backend-agnostic and only delegates model element operations
+ * to its internal {@link PersistentStore} which is responsible of database access.
*/
public class DefaultPersistentResource extends ResourceImpl implements PersistentResource {
@@ -312,19 +312,19 @@ public DummyRootEObject(Resource.Internal resource) {
private static class PersistenceBackendShutdownHook extends Thread {
/**
- * The backend to stop when the application will exit
+ * The back-end to stop when the application will exit.
*/
private final PersistenceBackend backend;
/**
- * The {@link URI} of the resource used by the {@code backend}
+ * The {@link URI} of the resource used by the {@code backend}.
*/
private final URI uri;
/**
* Creates a new {@code PersistenceBackendShutdownHook} with the given {@code backend}.
*
- * @param backend the backend to stop when the application will exit
+ * @param backend the back-end to stop when the application will exit
* @param uri the {@link URI} of the resource used by the {@code backend}
*/
private PersistenceBackendShutdownHook(PersistenceBackend backend, URI uri) {
@@ -335,7 +335,7 @@ private PersistenceBackendShutdownHook(PersistenceBackend backend, URI uri) {
/**
* Adds a shutdown hook on the given {@code backend}. It will be stopped when the application will exit.
*
- * @param backend the backend to stop when the application will exit
+ * @param backend the back-end to stop when the application will exit
* @param uri the {@link URI} of the resource used by the {@code backend}
*/
public static void closeOnExit(PersistenceBackend backend, URI uri) {
diff --git a/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/resource/PersistentResource.java b/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/resource/PersistentResource.java
index 6830948907..be342d6de0 100644
--- a/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/resource/PersistentResource.java
+++ b/neoemf-core/src/main/java/fr/inria/atlanmod/neoemf/resource/PersistentResource.java
@@ -14,7 +14,6 @@
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EObject;
-import org.eclipse.emf.ecore.InternalEObject;
import org.eclipse.emf.ecore.InternalEObject.EStore;
import org.eclipse.emf.ecore.resource.Resource;
@@ -22,8 +21,8 @@
/**
* Extends the {@link Resource} interface by providing efficient model-level operations that
- * are not accessible using the standard EMF API. For example, {@code getAllInstances} is a
- * utility method that computes efficiently all the instances of a given type by delegating the
+ * are not accessible using the standard EMF API. For example, {@code getAllInstances} is a
+ * utility method that computes efficiently all the instances of a given type by delegating the
* operation to the underlying database, that can benefits of its internal optimizations and indices.
*/
public interface PersistentResource extends Resource, Resource.Internal, Closeable {
@@ -32,10 +31,11 @@ public interface PersistentResource extends Resource, Resource.Internal, Closeab
void close();
/**
+ * Returns the {@link EStore} used to store the model.
*
- * @return the {@link EStore} used to store the model
+ * @return the {@link EStore}
*/
- InternalEObject.EStore eStore();
+ EStore eStore();
/**
* Computes the set of instances of the given {@link EClass} (including its sub-types).
diff --git a/neoemf-core/src/test/java/fr/inria/atlanmod/neoemf/data/AbstractPersistenceBackendFactoryTest.java b/neoemf-core/src/test/java/fr/inria/atlanmod/neoemf/data/AbstractPersistenceBackendFactoryTest.java
index e8b15679a1..b31817836d 100644
--- a/neoemf-core/src/test/java/fr/inria/atlanmod/neoemf/data/AbstractPersistenceBackendFactoryTest.java
+++ b/neoemf-core/src/test/java/fr/inria/atlanmod/neoemf/data/AbstractPersistenceBackendFactoryTest.java
@@ -26,6 +26,21 @@ public abstract class AbstractPersistenceBackendFactoryTest extends AbstractUnit
private static final String INNER_BACKEND_FIELDNAME = "backend";
+ private static
- * Providing efficient model import and export is tightly coupled to the database and the data representation. In order to provide this
- * feature, a backend module should contain an I/O specific package that overrides {@link fr.inria.atlanmod.neoemf.io.persistence.AbstractPersistenceHandler}.
- *
+ * Providing efficient model import and export is tightly coupled to the database and the data representation. In order
+ * to provide this feature, a back-end module should contain an I/O specific package that overrides {@link
+ * fr.inria.atlanmod.neoemf.io.persistence.AbstractPersistenceHandler}.
+ *
* @see fr.inria.atlanmod.neoemf.io.persistence.AbstractPersistenceHandler
*/
diff --git a/neoemf-data/blueprints/core/src/main/javadoc/fr/inria/atlanmod/neoemf/data/blueprints/option/package-info.java b/neoemf-data/blueprints/core/src/main/javadoc/fr/inria/atlanmod/neoemf/data/blueprints/option/package-info.java
index 9785b384bc..7bf90ad4cc 100644
--- a/neoemf-data/blueprints/core/src/main/javadoc/fr/inria/atlanmod/neoemf/data/blueprints/option/package-info.java
+++ b/neoemf-data/blueprints/core/src/main/javadoc/fr/inria/atlanmod/neoemf/data/blueprints/option/package-info.java
@@ -11,10 +11,9 @@
/**
* Provides utility classes to define specific behaviors of Blueprints data persistence.
- *
- * @note Options defined using the classes inside this package are usable for each Blueprints
- * implementation. For backend-specific configuration refers to the corresponding package in the
- * backend plugin.
+ *
+ * @note Options defined using the classes inside this package are usable for each Blueprints implementation. For
+ * backend-specific configuration refers to the corresponding package in the backend plugin.
*/
package fr.inria.atlanmod.neoemf.data.blueprints.option;
\ No newline at end of file
diff --git a/neoemf-data/blueprints/neo4j/src/main/javadoc/fr/inria/atlanmod/neoemf/data/blueprints/neo4j/option/package-info.java b/neoemf-data/blueprints/neo4j/src/main/javadoc/fr/inria/atlanmod/neoemf/data/blueprints/neo4j/option/package-info.java
index 4d3b5269b3..768f45697a 100644
--- a/neoemf-data/blueprints/neo4j/src/main/javadoc/fr/inria/atlanmod/neoemf/data/blueprints/neo4j/option/package-info.java
+++ b/neoemf-data/blueprints/neo4j/src/main/javadoc/fr/inria/atlanmod/neoemf/data/blueprints/neo4j/option/package-info.java
@@ -11,11 +11,9 @@
/**
* Provides utility classes to define specific behaviors of Neo4j data persistence.
- *
- * @note Options defined using the classes inside this package are only usable with Neo4j as the concrete
- * implementation of the Blueprints API. Neo4j specific options can be combined with Blueprints generic
- * options.
- *
+ *
+ * @note Options defined using the classes inside this package are only usable with Neo4j as the concrete implementation
+ * of the Blueprints API. Neo4j specific options can be combined with Blueprints generic options.
* @see fr.inria.atlanmod.neoemf.data.blueprints.option.BlueprintsOptionsBuilder
*/
diff --git a/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/HBasePersistenceBackend.java b/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/HBasePersistenceBackend.java
index 5aba9c71dd..ec6e23d62a 100644
--- a/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/HBasePersistenceBackend.java
+++ b/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/HBasePersistenceBackend.java
@@ -20,12 +20,12 @@
* Mock {@link PersistenceBackend} implementation for HBase to fit core architecture.
*
* This class does not access HBase database, but is here to fit the requirement of the
- * core architecture. For historical reasons the real access to the HBase Table
+ * core architecture. For historical reasons the real access to the HBase Table
* is done in {@link DirectWriteHBaseStore} and {@link ReadOnlyHBaseStore}.
*
- * Moving HBase access to this class to fit NeoEMF backend architecture is planned in
+ * Moving HBase access to this class to fit NeoEMF back-end architecture is planned in
* a future release.
- *
+ *
* @see DirectWriteHBaseStore
* @see ReadOnlyHBaseStore
*/
diff --git a/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/HBasePersistenceBackendFactory.java b/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/HBasePersistenceBackendFactory.java
index 7d260313eb..34afdfd1fa 100644
--- a/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/HBasePersistenceBackendFactory.java
+++ b/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/HBasePersistenceBackendFactory.java
@@ -36,15 +36,15 @@
/**
* A factory that creates instances of {@link HBasePersistenceBackend}.
*
- * This class only creates persistent databases that can be configured using
+ * This class only creates persistent databases that can be configured using
* {@link PersistentResource#save(Map)} and {@link PersistentResource#load(Map)}
* options maps.
*
- * Note that transient backends can be instantiated using this factory, but they will
+ * Note that transient back-ends can be instantiated using this factory, but they will
* be handed as persistent ones. This is a limitation that will be solved in next releases.
* To avoid any consistency issue we recommend every HBase resource right after their creation,
- * ensuring the resource is using a persistent backend.
- *
+ * ensuring the resource is using a persistent back-end.
+ *
* @see PersistentResource
* @see HBasePersistenceBackend
* @see HBaseOptionsBuilder
diff --git a/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/store/DirectWriteHBaseStore.java b/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/store/DirectWriteHBaseStore.java
index f3d67402bd..2ee114ffea 100644
--- a/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/store/DirectWriteHBaseStore.java
+++ b/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/store/DirectWriteHBaseStore.java
@@ -66,15 +66,14 @@
* An {@link AbstractDirectWriteStore} that translates model-level operations to HBase operations.
*
* This class implements the {@link PersistentStore} interface that defines a set of operations to implement in order to
- * allow EMF persistence delegation. If this store is used, every method call and property access on {@link PersistentEObject}
- * is forwarded to this class, that takes care of the serialization/deserialization from/to HBase.
- *
- * @note For historical purposes this class does not use a {@link HBasePersistenceBackend}, instead,
- * it accesses HBase directly using the low-level database API.
+ * allow EMF persistence delegation. If this store is used, every method call and property access on {@link
+ * PersistentEObject} is forwarded to this class, that takes care of the serialization/deserialization from/to HBase.
+ *
+ * @note For historical purposes this class does not use a {@link HBasePersistenceBackend}, instead, it accesses HBase
+ * directly using the low-level database API.
*
- * This store can be used as a base store that can be complemented by plugging decorator stores on top of it
- * (see {@link AbstractPersistentStoreDecorator} subclasses) to provide additional features such as caching or logging.
- *
+ * This store can be used as a base store that can be complemented by plugging decorator stores on top of it (see {@link
+ * AbstractPersistentStoreDecorator} subclasses) to provide additional features such as caching or logging.
* @see PersistentEObject
* @see HBasePersistenceBackend
* @see AbstractDirectWriteStore
@@ -172,7 +171,7 @@ public DirectWriteHBaseStore(Resource.Internal resource) throws IOException {
*
* @param connection the connection to the HBase server
* @param tableName the name of the table to access on the server
- * @param admin the administrator client of the HBase server
+ * @param admin the administrator client of the HBase server
*
* @return the created HBase table containing the columns and column families to store the model
*
@@ -194,12 +193,13 @@ protected Table initTable(Connection connection, TableName tableName, Admin admi
/**
* A specific implementation of {@link EStore#add(InternalEObject, EStructuralFeature, int, Object)} that takes
- * benefit of the HBase facilities to append an element in a multi-valued {@link EReference} without deserializing
+ * benefit of the HBase facilities to append an element in a multi-valued {@link EReference} without de-serializing
* the entire collection.
*
* @param object the source element
- * @param reference the multi-valued {@link EReference}
- * @param atEnd {@code true} to append {@code referencedObject} at the end of the collection, {@code false} to put it at the beginning (if the persisted collection is empty)
+ * @param reference the multi-valued {@link EReference}
+ * @param atEnd {@code true} to append {@code referencedObject} at the end of the collection, {@code
+ * false} to put it at the beginning (if the persisted collection is empty)
* @param referencedObject the {@link PersistentEObject} to append
*
* @throws IOException if the HBase database cannot be found
@@ -316,7 +316,7 @@ protected void updateContainment(PersistentEObject object, EReference reference,
}
/**
- * Computes {@code object}'s metaclass informations and persists them in the database.
+ * Computes {@code object}'s metaclass information and persists them in the database.
*
* @param object the {@link PersistentEObject} to persist the metaclass of
*/
diff --git a/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/store/ReadOnlyHBaseStore.java b/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/store/ReadOnlyHBaseStore.java
index 36b71e25bc..2b239560b0 100644
--- a/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/store/ReadOnlyHBaseStore.java
+++ b/neoemf-data/hbase/src/main/java/fr/inria/atlanmod/neoemf/data/hbase/store/ReadOnlyHBaseStore.java
@@ -42,17 +42,17 @@
* A {@link DirectWriteHBaseStore} that only allows read operations on the underlying database.
*
* Read-only configuration allows to access model element faster, without checking value consistency
- * between database calls. This store reimplements all the mutators and throws an
+ * between database calls. This store re-implements all the mutators and throws an
* {@link UnsupportedOperationException} when they are called, preventing resource corruption.
*
- * * This store can be used as a base store that can be complemented by plugging decorator stores on top of it
+ * * This store can be used as a base store that can be complemented by plugging decorator stores on top of it
* (see {@link AbstractPersistentStoreDecorator} subclasses) to provide additional features such as caching or logging.
- *
*/
public class ReadOnlyHBaseStore extends DirectWriteHBaseStore {
/**
- * In-memory cache that holds persisted model elements identifiers mapped to the {@link FeatureKey} used to access them.
+ * In-memory cache that holds persisted model elements identifiers mapped to the {@link FeatureKey} used to access
+ * them.
*/
private final Cache
+ *
* @note Read-only mode is only available for existing databases.
*
* @param connection the connection to the HBase server
* @param tableName the name of the table to access on the server
- * @param admin the administrator client of the HBase server
+ * @param admin the administrator client of the HBase server
*
* @return the opened HBase table
*
- * @throws IOException if the HBase server cannot be found or if {@code tableName} does not reference an existing table
+ * @throws IOException if the HBase server cannot be found or if {@code tableName} does not reference an existing
+ * table
*/
@Override
protected Table initTable(Connection connection, TableName tableName, Admin admin) throws IOException {
diff --git a/neoemf-data/hbase/src/main/javadoc/fr/inria/atlanmod/neoemf/data/hbase/util/package-info.java b/neoemf-data/hbase/src/main/javadoc/fr/inria/atlanmod/neoemf/data/hbase/util/package-info.java
index 3b504e9cea..965bae4907 100644
--- a/neoemf-data/hbase/src/main/javadoc/fr/inria/atlanmod/neoemf/data/hbase/util/package-info.java
+++ b/neoemf-data/hbase/src/main/javadoc/fr/inria/atlanmod/neoemf/data/hbase/util/package-info.java
@@ -10,7 +10,7 @@
*/
/**
- * Provides utility classes to create HBase specific URIs, serialize and deserialize HBase records, and
+ * Provides utility classes to create HBase specific URIs, serialize and deserialize HBase records, and
* manage HBase resource life-cycle.
*/
diff --git a/neoemf-data/map/mapdb/src/main/java/fr/inria/atlanmod/neoemf/data/mapdb/MapDbPersistenceBackend.java b/neoemf-data/map/mapdb/src/main/java/fr/inria/atlanmod/neoemf/data/mapdb/MapDbPersistenceBackend.java
index e8fb438bd3..511e433c6e 100644
--- a/neoemf-data/map/mapdb/src/main/java/fr/inria/atlanmod/neoemf/data/mapdb/MapDbPersistenceBackend.java
+++ b/neoemf-data/map/mapdb/src/main/java/fr/inria/atlanmod/neoemf/data/mapdb/MapDbPersistenceBackend.java
@@ -217,7 +217,7 @@ public void storeContainer(Id id, ContainerInfo container) {
*
* @param id the {@link Id} of the element
*
- * @return a {@link ClassInfo} descriptor containing element's metaclass informations ({@link EClass}, metamodel
+ * @return a {@link ClassInfo} descriptor containing element's metaclass information ({@link EClass}, meta-model
* name, and {@code nsURI})
*/
public ClassInfo metaclassFor(Id id) {
@@ -228,8 +228,8 @@ public ClassInfo metaclassFor(Id id) {
* Stores metaclass ({@link EClass}) information for the element with the given {@link Id}.
*
* @param id the {@link Id} of the element
- * @param metaclass the {@link ClassInfo} descriptor containing element's metaclass informations ({@link EClass},
- * metamodel name, and {@code nsURI})
+ * @param metaclass the {@link ClassInfo} descriptor containing element's metaclass information ({@link EClass},
+ * meta-model name, and {@code nsURI})
*/
public void storeMetaclass(Id id, ClassInfo metaclass) {
instanceOfMap.put(id, metaclass);
diff --git a/neoemf-data/map/mapdb/src/main/java/fr/inria/atlanmod/neoemf/data/mapdb/option/MapDbOptionsBuilder.java b/neoemf-data/map/mapdb/src/main/java/fr/inria/atlanmod/neoemf/data/mapdb/option/MapDbOptionsBuilder.java
index 8de0d66957..5dd50fc5f3 100644
--- a/neoemf-data/map/mapdb/src/main/java/fr/inria/atlanmod/neoemf/data/mapdb/option/MapDbOptionsBuilder.java
+++ b/neoemf-data/map/mapdb/src/main/java/fr/inria/atlanmod/neoemf/data/mapdb/option/MapDbOptionsBuilder.java
@@ -74,7 +74,7 @@ public MapDbOptionsBuilder directWrite() {
}
/**
- * Adds the {@code direct-write-with-lists} feature in the created options.
+ * Adds the {@code direct-write-with-lists} feature in the created options.
*
* @return this builder (for chaining)
*
diff --git a/plugins/eclipse/ui/src/main/java/fr/inria/atlanmod/neoemf/eclipse/ui/editor/LazyAdapterFactoryContentProvider.java b/plugins/eclipse/ui/src/main/java/fr/inria/atlanmod/neoemf/eclipse/ui/editor/LazyAdapterFactoryContentProvider.java
index 60432e610a..314af02eb5 100644
--- a/plugins/eclipse/ui/src/main/java/fr/inria/atlanmod/neoemf/eclipse/ui/editor/LazyAdapterFactoryContentProvider.java
+++ b/plugins/eclipse/ui/src/main/java/fr/inria/atlanmod/neoemf/eclipse/ui/editor/LazyAdapterFactoryContentProvider.java
@@ -27,7 +27,8 @@
public class LazyAdapterFactoryContentProvider extends AdapterFactoryContentProvider implements
ILazyTreeContentProvider, INotifyChangedListener, ITreeContentProvider,
- IPropertySourceProvider {
+ IPropertySourceProvider
+{
public LazyAdapterFactoryContentProvider(AdapterFactory adapterFactory) {
super(adapterFactory);