Simplifications and renamings

Signed-off-by: Laurent Garnier <[email protected]>

Author: lolodomo

bundles/org.openhab.core.model.core/src/main/java/org/openhab/core/model/core/ModelRepository.java

@@ -29,7 +29,7 @@
  *
  * @author Kai Kreuzer - Initial contribution
  * @author Laurent Garnier - Added method generateSyntaxFromModel
- * @author Laurent Garnier - Added methods addStandaloneModel and removeStandaloneModel
+ * @author Laurent Garnier - Added methods createIsolatedModel and removeIsolatedModel
  */
 @NonNullByDefault
 public interface ModelRepository {
@@ -98,8 +98,10 @@ public interface ModelRepository {
     void removeModelRepositoryChangeListener(ModelRepositoryChangeListener listener);
 
     /**
-     * Adds a standalone model to the repository
-     * A standalone model will be loaded without triggering any listener.
+     * Creates an isolated model in the repository
+     *
+     * An isolated model is a temporary model that will be loaded without triggering any listener
+     * and so without impacting any object registry.
      *
      * @param modelType the model type
      * @param inputStream an input stream with the model's content
@@ -108,15 +110,15 @@ public interface ModelRepository {
      * @return the created model name if it was successfully processed, null otherwise
      */
     @Nullable
-    String addStandaloneModel(String modelType, InputStream inputStream, List<String> errors, List<String> warnings);
+    String createIsolatedModel(String modelType, InputStream inputStream, List<String> errors, List<String> warnings);
 
     /**
-     * Removes a standalone model from the repository
+     * Removes an isolated model from the repository
      *
      * @param name the name of the model to remove
      * @return true, if model was removed, false, if it did not exist
      */
-    boolean removeStandaloneModel(String name);
+    boolean removeIsolatedModel(String name);
 
     /**
      * Generate the syntax from a provided model content.

bundles/org.openhab.core.model.core/src/main/java/org/openhab/core/model/core/internal/ModelRepositoryImpl.java

@@ -51,7 +51,7 @@
  * @author Oliver Libutzki - Added reloadAllModelsOfType method
  * @author Simon Kaufmann - added validation of models before loading them
  * @author Laurent Garnier - Added method generateSyntaxFromModel
- * @author Laurent Garnier - Added methods addStandaloneModel and removeStandaloneModel
+ * @author Laurent Garnier - Added methods createIsolatedModel and removeIsolatedModel
  */
 @Component(immediate = true)
 @NonNullByDefault
@@ -104,7 +104,7 @@ public boolean addOrRefreshModel(String name, final InputStream originalInputStr
     }
 
     public boolean addOrRefreshModel(String name, final InputStream originalInputStream, @Nullable List<String> errors,
-            @Nullable List<String> warnings, boolean standalone) {
+            @Nullable List<String> warnings, boolean isolated) {
         logger.info("Loading model '{}'", name);
         Resource resource = null;
         byte[] bytes;
@@ -120,14 +120,14 @@ public boolean addOrRefreshModel(String name, final InputStream originalInputStr
                 warnings.addAll(newWarnings);
             }
             if (!valid) {
-                if (!standalone) {
+                if (!isolated) {
                     logger.warn("Configuration model '{}' has errors, therefore ignoring it: {}", name,
                             String.join("\n", newErrors));
                 }
                 removeModel(name);
                 return false;
             }
-            if (!standalone && !newWarnings.isEmpty()) {
+            if (!isolated && !newWarnings.isEmpty()) {
                 logger.info("Validation issues found in configuration model '{}', using it anyway:\n{}", name,
                         String.join("\n", newWarnings));
             }
@@ -148,7 +148,7 @@ public boolean addOrRefreshModel(String name, final InputStream originalInputStr
                         resource = resourceSet.createResource(URI.createURI(name));
                         if (resource != null) {
                             resource.load(inputStream, resourceOptions);
-                            if (!standalone) {
+                            if (!isolated) {
                                 notifyListeners(name, EventType.ADDED);
                             }
                             return true;
@@ -161,7 +161,7 @@ public boolean addOrRefreshModel(String name, final InputStream originalInputStr
                 synchronized (resourceSet) {
                     resource.unload();
                     resource.load(inputStream, resourceOptions);
-                    if (!standalone) {
+                    if (!isolated) {
                         notifyListeners(name, EventType.MODIFIED);
                     }
                     return true;
@@ -181,12 +181,12 @@ public boolean removeModel(String name) {
         return removeModel(name, false);
     }
 
-    private boolean removeModel(String name, boolean standalone) {
+    private boolean removeModel(String name, boolean isolated) {
         Resource resource = getResource(name);
         if (resource != null) {
             synchronized (resourceSet) {
                 // do not physically delete it, but remove it from the resource set
-                if (!standalone) {
+                if (!isolated) {
                     notifyListeners(name, EventType.REMOVED);
                 }
                 resourceSet.getResources().remove(resource);
@@ -263,14 +263,14 @@ public void removeModelRepositoryChangeListener(ModelRepositoryChangeListener li
     }
 
     @Override
-    public @Nullable String addStandaloneModel(String modelType, InputStream inputStream, List<String> errors,
+    public @Nullable String createIsolatedModel(String modelType, InputStream inputStream, List<String> errors,
             List<String> warnings) {
-        String name = "tmp_syntax_%d.%s".formatted(++counter, modelType);
+        String name = "tmp_isolated_model_%d.%s".formatted(++counter, modelType);
         return addOrRefreshModel(name, inputStream, errors, warnings, true) ? name : null;
     }
 
     @Override
-    public boolean removeStandaloneModel(String name) {
+    public boolean removeIsolatedModel(String name) {
         return removeModel(name, true);
     }
 

bundles/org.openhab.core.model.item/src/org/openhab/core/model/item/internal/GenericItemProvider.java

@@ -15,7 +15,6 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -68,13 +67,12 @@
  *
  * @author Kai Kreuzer - Initial contribution
  * @author Thomas Eichstaedt-Engelen - Initial contribution
- * @author Laurent Garnier - Add interface StandaloneItemProvider
  */
 @NonNullByDefault
-@Component(service = { ItemProvider.class, StandaloneItemProvider.class,
+@Component(service = { ItemProvider.class, GenericItemProvider.class,
         StateDescriptionFragmentProvider.class }, immediate = true)
-public class GenericItemProvider extends AbstractProvider<Item> implements ModelRepositoryChangeListener, ItemProvider,
-        StandaloneItemProvider, StateDescriptionFragmentProvider {
+public class GenericItemProvider extends AbstractProvider<Item>
+        implements ModelRepositoryChangeListener, ItemProvider, StateDescriptionFragmentProvider {
 
     private final Logger logger = LoggerFactory.getLogger(GenericItemProvider.class);
 
@@ -173,7 +171,7 @@ public Collection<Item> getAll() {
         return items;
     }
 
-    private List<Item> getItemsFromModel(String modelName) {
+    public List<Item> getItemsFromModel(String modelName) {
         logger.debug("Read items from model '{}'", modelName);
 
         List<Item> items = new ArrayList<>();
@@ -524,14 +522,6 @@ private Map<String, Item> toItemMap(@Nullable Collection<Item> items) {
         return null;
     }
 
-    @Override
-    public List<Item> getItemsFromStandaloneModel(String modelName) {
-        if (modelName.endsWith("items")) {
-            return getItemsFromModel(modelName);
-        }
-        return Collections.emptyList();
-    }
-
     @Override
     public @Nullable StateDescriptionFragment getStateDescriptionFragment(String itemName, @Nullable Locale locale) {
         return stateDescriptionFragments.get(itemName);

bundles/org.openhab.core.model.item/src/org/openhab/core/model/item/internal/StandaloneItemProvider.java

@@ -40,7 +40,7 @@
 import org.openhab.core.items.fileconverter.ItemFileGenerator;
 import org.openhab.core.items.fileconverter.ItemFileParser;
 import org.openhab.core.model.core.ModelRepository;
-import org.openhab.core.model.item.internal.StandaloneItemProvider;
+import org.openhab.core.model.item.internal.GenericItemProvider;
 import org.openhab.core.model.items.ItemModel;
 import org.openhab.core.model.items.ItemsFactory;
 import org.openhab.core.model.items.ModelBinding;
@@ -69,15 +69,15 @@ public class DslItemFileConverter extends AbstractItemFileGenerator implements I
     private final Logger logger = LoggerFactory.getLogger(DslItemFileConverter.class);
 
     private final ModelRepository modelRepository;
-    private final StandaloneItemProvider standaloneItemProvider;
+    private final GenericItemProvider itemProvider;
     private final ConfigDescriptionRegistry configDescriptionRegistry;
 
     @Activate
     public DslItemFileConverter(final @Reference ModelRepository modelRepository,
-            final @Reference StandaloneItemProvider standaloneItemProvider,
+            final @Reference GenericItemProvider itemProvider,
             final @Reference ConfigDescriptionRegistry configDescriptionRegistry) {
         this.modelRepository = modelRepository;
-        this.standaloneItemProvider = standaloneItemProvider;
+        this.itemProvider = itemProvider;
         this.configDescriptionRegistry = configDescriptionRegistry;
     }
 
@@ -270,9 +270,9 @@ public String getFileFormatParser() {
     public boolean parseFileFormat(String syntax, List<Item> items, List<Metadata> metadata, List<String> errors,
             List<String> warnings) {
         ByteArrayInputStream inputStream = new ByteArrayInputStream(syntax.getBytes());
-        String modelName = modelRepository.addStandaloneModel("items", inputStream, errors, warnings);
+        String modelName = modelRepository.createIsolatedModel("items", inputStream, errors, warnings);
         if (modelName != null) {
-            items.addAll(standaloneItemProvider.getItemsFromStandaloneModel(modelName));
+            items.addAll(itemProvider.getItemsFromModel(modelName));
             // TODO retrieve metadata
             for (Item item : items) {
                 MetadataKey key;
@@ -293,7 +293,7 @@ public boolean parseFileFormat(String syntax, List<Item> items, List<Metadata> m
                 md = new Metadata(key, "myBinding:myTypoe:myThing#channel2", null);
                 metadata.add(md);
             }
-            modelRepository.removeStandaloneModel(modelName);
+            modelRepository.removeIsolatedModel(modelName);
             return true;
         }
         return false;

bundles/org.openhab.core.model.item/src/org/openhab/core/model/item/internal/fileconverter/DslItemFileConverter.java

@@ -73,8 +73,8 @@ import org.slf4j.LoggerFactory
  * @author Markus Rathgeb - Add locale provider support
  * @author Laurent Garnier - Add interface StandaloneThingProvider
  */
-@Component(immediate=true, service=#[ThingProvider, StandaloneThingProvider])
-class GenericThingProvider extends AbstractProviderLazyNullness<Thing> implements ThingProvider, StandaloneThingProvider, ModelRepositoryChangeListener, ReadyService.ReadyTracker {
+@Component(immediate=true, service=#[ ThingProvider, GenericThingProvider ])
+class GenericThingProvider extends AbstractProviderLazyNullness<Thing> implements ThingProvider, ModelRepositoryChangeListener, ReadyService.ReadyTracker {
 
     static final String XML_THING_TYPE = "openhab.xmlThingTypes";
 
@@ -491,7 +491,7 @@ class GenericThingProvider extends AbstractProviderLazyNullness<Thing> implement
         }
     }
 
-    override List<Thing> getThingsFromStandaloneModel(String modelName) {
+    def public List<Thing> getThingsFromIsolatedModel(String modelName) {
         val things = newArrayList()
         if (modelRepository !== null && modelName.endsWith("things")) {
             logger.debug("Read standalone things from model '{}'", modelName);

bundles/org.openhab.core.model.thing/src/org/openhab/core/model/thing/internal/GenericThingProvider.xtend

@@ -25,7 +25,7 @@
 import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.core.config.core.ConfigDescriptionRegistry;
 import org.openhab.core.model.core.ModelRepository;
-import org.openhab.core.model.thing.internal.StandaloneThingProvider;
+import org.openhab.core.model.thing.internal.GenericThingProvider;
 import org.openhab.core.model.thing.thing.ModelBridge;
 import org.openhab.core.model.thing.thing.ModelChannel;
 import org.openhab.core.model.thing.thing.ModelProperty;
@@ -62,17 +62,16 @@ public class DslThingFileConverter extends AbstractThingFileGenerator implements
     private final Logger logger = LoggerFactory.getLogger(DslThingFileConverter.class);
 
     private final ModelRepository modelRepository;
-    private final StandaloneThingProvider standaloneThingProvider;
+    private final GenericThingProvider thingProvider;
 
     @Activate
     public DslThingFileConverter(final @Reference ModelRepository modelRepository,
-            final @Reference StandaloneThingProvider standaloneThingProvider,
-            final @Reference ThingTypeRegistry thingTypeRegistry,
+            final @Reference GenericThingProvider thingProvider, final @Reference ThingTypeRegistry thingTypeRegistry,
             final @Reference ChannelTypeRegistry channelTypeRegistry,
             final @Reference ConfigDescriptionRegistry configDescRegistry) {
         super(thingTypeRegistry, channelTypeRegistry, configDescRegistry);
         this.modelRepository = modelRepository;
-        this.standaloneThingProvider = standaloneThingProvider;
+        this.thingProvider = thingProvider;
     }
 
     @Override
@@ -213,10 +212,10 @@ public String getFileFormatParser() {
     @Override
     public boolean parseFileFormat(String syntax, List<Thing> things, List<String> errors, List<String> warnings) {
         ByteArrayInputStream inputStream = new ByteArrayInputStream(syntax.getBytes());
-        String modelName = modelRepository.addStandaloneModel("things", inputStream, errors, warnings);
+        String modelName = modelRepository.createIsolatedModel("things", inputStream, errors, warnings);
         if (modelName != null) {
-            things.addAll(standaloneThingProvider.getThingsFromStandaloneModel(modelName));
-            modelRepository.removeStandaloneModel(modelName);
+            things.addAll(thingProvider.getThingsFromIsolatedModel(modelName));
+            modelRepository.removeIsolatedModel(modelName);
             return true;
         }
         return false;