Issue #2258 - Typeful Metadata

platform-benchmark/src/main/java/ua/com/fielden/eql/AbstractEqlBenchmark.java

@@ -2,19 +2,17 @@
 
 import com.google.inject.Guice;
 import com.google.inject.Injector;
-import org.hibernate.Hibernate;
 import org.hibernate.type.YesNoType;
 import org.openjdk.jmh.annotations.Benchmark;
 import org.openjdk.jmh.infra.Blackhole;
 import ua.com.fielden.platform.entity.meta.PropertyDescriptor;
 import ua.com.fielden.platform.entity.query.IFilter;
 import ua.com.fielden.platform.entity.query.generation.ioc.HelperIocModule;
-import ua.com.fielden.platform.entity.query.metadata.DomainMetadata;
-import ua.com.fielden.platform.entity.query.metadata.DomainMetadataAnalyser;
 import ua.com.fielden.platform.entity.query.model.QueryModel;
 import ua.com.fielden.platform.eql.meta.SimpleUserFilter;
 import ua.com.fielden.platform.ioc.HibernateUserTypesModule;
-import ua.com.fielden.platform.persistence.HibernateHelpers;
+import ua.com.fielden.platform.meta.DomainMetadataBuilder;
+import ua.com.fielden.platform.meta.IDomainMetadata;
 import ua.com.fielden.platform.persistence.types.*;
 import ua.com.fielden.platform.sample.domain.*;
 import ua.com.fielden.platform.test.PlatformTestDomainTypes;
@@ -314,8 +312,7 @@ public void generated_conditions_x20(final Blackhole blackhole) {
     protected static final IDates dates = injector.getInstance(IDates.class);
     protected static final IFilter filter = new SimpleUserFilter();
 
-    protected static final DomainMetadata DOMAIN_METADATA;
-    protected static final DomainMetadataAnalyser DOMAIN_METADATA_ANALYSER;
+    protected static final IDomainMetadata DOMAIN_METADATA;
 
     static {
         hibTypeDefaults.put(boolean.class, YesNoType.class);
@@ -326,8 +323,7 @@ public void generated_conditions_x20(final Blackhole blackhole) {
         hibTypeDefaults.put(Colour.class, ColourType.class);
         hibTypeDefaults.put(Hyperlink.class, HyperlinkType.class);
 
-        DOMAIN_METADATA = new DomainMetadata(hibTypeDefaults, injector, PlatformTestDomainTypes.entityTypes, HibernateHelpers.getDialect(H2));
-        DOMAIN_METADATA_ANALYSER = new DomainMetadataAnalyser(DOMAIN_METADATA);
+        DOMAIN_METADATA = new DomainMetadataBuilder(hibTypeDefaults, injector, PlatformTestDomainTypes.entityTypes, H2).build();
     }
 
     protected static final EqlRandomGenerator ELQ_GENERATOR = new EqlRandomGenerator(new Random(9375679861L));

platform-dao/src/main/java/ua/com/fielden/platform/dao/CommonEntityDao.java

@@ -21,9 +21,9 @@
 import ua.com.fielden.platform.entity.meta.MetaProperty;
 import ua.com.fielden.platform.entity.query.*;
 import ua.com.fielden.platform.entity.query.fluent.fetch;
-import ua.com.fielden.platform.entity.query.metadata.DomainMetadata;
 import ua.com.fielden.platform.entity.query.model.EntityResultQueryModel;
 import ua.com.fielden.platform.file_reports.WorkbookExporter;
+import ua.com.fielden.platform.meta.IDomainMetadata;
 import ua.com.fielden.platform.reflection.AnnotationReflector;
 import ua.com.fielden.platform.security.user.IUserProvider;
 import ua.com.fielden.platform.security.user.User;
@@ -59,7 +59,7 @@ public abstract class CommonEntityDao<T extends AbstractEntity<?>> extends Abstr
 
     private Session session;
     private String transactionGuid;
-    private DomainMetadata domainMetadata;
+    private IDomainMetadata domainMetadata;
     private IdOnlyProxiedEntityTypeCache idOnlyProxiedEntityTypeCache;
 
     @Inject
@@ -110,7 +110,7 @@ protected CommonEntityDao(final IFilter filter) {
                 this::getSession,
                 entityType,
                 this::newQueryExecutionContext,
-                () -> new EntityBatchDeleteByIdsOperation<>(getSession(), getDomainMetadata().eqlDomainMetadata.entityMetadataHolder.getTableForEntityType(entityType)));
+                () -> new EntityBatchDeleteByIdsOperation<>(getSession(), getDomainMetadata().getTableForEntityType(entityType)));
 
         entitySaver = new PersistentEntitySaver<>(
                 this::getSession,
@@ -141,7 +141,6 @@ protected QueryExecutionContext newQueryExecutionContext() {
                 getEntityFactory(),
                 getCoFinder(),
                 getDomainMetadata(),
-                getDomainMetadata().eqlDomainMetadata,
                 getFilter(),
                 getUsername(),
                 dates,
@@ -154,13 +153,13 @@ protected QueryExecutionContext newQueryExecutionContext() {
      * @param domainMetadata
      */
     @Inject
-    protected void setDomainMetadata(final DomainMetadata domainMetadata) {
+    protected void setDomainMetadata(final IDomainMetadata domainMetadata) {
         this.domainMetadata = domainMetadata;
     }
 
     @Override
     public DbVersion getDbVersion() {
-        return domainMetadata.getDbVersion();
+        return domainMetadata.dbVersion();
     }
 
     @Inject
@@ -329,7 +328,7 @@ public byte[] export(final QueryExecutionModel<T, ?> query, final String[] prope
         return WorkbookExporter.convertToGZipByteArray(WorkbookExporter.export(stream(query), propertyNames, propertyTitles));
     }
 
-    public DomainMetadata getDomainMetadata() {
+    public IDomainMetadata getDomainMetadata() {
         return domainMetadata;
     }
 
@@ -673,4 +672,4 @@ public T new_() {
         return entityFactory.newEntity(getEntityType());
     }
 
-}
+}

platform-dao/src/main/java/ua/com/fielden/platform/dao/GeneratedEntityDao.java

@@ -50,6 +50,10 @@ public Class<T> getEntityType() {
 
     @Override
     public void setEntityType(final Class<T> type) {
+        // It is important to use a companion that produces instrumented instances.
+        // This is to support customisation where necessary to retrieve either instrumented or unstrumented entity instances,
+        // which is controlled by using lightweight query models to avoid instrumentation.
+        // The use of lightweight query models is the default for Entity Centres.
         this.companion = coFinder.find(type);
     }
 

platform-dao/src/main/java/ua/com/fielden/platform/devdb_support/DomainDrivenDataPopulation.java

@@ -1,16 +1,9 @@
 package ua.com.fielden.platform.devdb_support;
 
 import static java.lang.String.format;
-import static ua.com.fielden.platform.entity.query.DbVersion.H2;
 
 import java.lang.reflect.Field;
 import java.math.BigDecimal;
-import java.sql.Connection;
-import java.sql.DriverManager;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-import java.sql.Statement;
-import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 import java.util.Properties;
@@ -25,7 +18,6 @@
 import ua.com.fielden.platform.entity.DynamicEntityKey;
 import ua.com.fielden.platform.entity.factory.EntityFactory;
 import ua.com.fielden.platform.entity.factory.ICompanionObjectFinder;
-import ua.com.fielden.platform.entity.query.metadata.PersistedEntityMetadata;
 import ua.com.fielden.platform.reflection.Finder;
 import ua.com.fielden.platform.test.IDomainDrivenTestCaseConfiguration;
 import ua.com.fielden.platform.types.Money;

platform-dao/src/main/java/ua/com/fielden/platform/entity/query/AbstractRetrievalModel.java

@@ -1,38 +1,35 @@
 package ua.com.fielden.platform.entity.query;
 
+import ua.com.fielden.platform.entity.AbstractEntity;
+import ua.com.fielden.platform.entity.query.exceptions.EqlException;
+import ua.com.fielden.platform.entity.query.fluent.fetch;
+import ua.com.fielden.platform.meta.IDomainMetadata;
+import ua.com.fielden.platform.meta.PropertyMetadata;
+
+import java.util.*;
+import java.util.Map.Entry;
+
+import static java.lang.Boolean.FALSE;
 import static java.lang.String.format;
 import static java.util.Collections.unmodifiableMap;
 import static java.util.Collections.unmodifiableSet;
 import static ua.com.fielden.platform.entity.AbstractEntity.ID;
 import static ua.com.fielden.platform.entity.AbstractEntity.VERSION;
-import static ua.com.fielden.platform.utils.EntityUtils.isEntityType;
-
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.Set;
-
-import ua.com.fielden.platform.entity.AbstractEntity;
-import ua.com.fielden.platform.entity.query.exceptions.EqlException;
-import ua.com.fielden.platform.entity.query.fluent.fetch;
-import ua.com.fielden.platform.entity.query.metadata.DomainMetadataAnalyser;
-import ua.com.fielden.platform.entity.query.metadata.PropertyMetadata;
 
 public abstract class AbstractRetrievalModel<T extends AbstractEntity<?>> implements IRetrievalModel<T> {
 
     protected final fetch<T> originalFetch;
-    private DomainMetadataAnalyser domainMetadataAnalyser;
+    protected final IDomainMetadata domainMetadata;
     public final boolean topLevel;
 
     private final Map<String, EntityRetrievalModel<? extends AbstractEntity<?>>> entityProps = new HashMap<>();
     private final Set<String> primProps = new HashSet<String>();
     private final Set<String> proxiedProps = new HashSet<String>();
 
-    protected AbstractRetrievalModel(final fetch<T> originalFetch, final DomainMetadataAnalyser domainMetadataAnalyser, final boolean topLevel) {
+    protected AbstractRetrievalModel(final fetch<T> originalFetch, final IDomainMetadata domainMetadata, final boolean topLevel) {
         this.originalFetch = originalFetch;
-        this.domainMetadataAnalyser = domainMetadataAnalyser;
         this.topLevel = topLevel;
+        this.domainMetadata = domainMetadata;
     }
 
     public fetch<T> getOriginalFetch() {
@@ -43,10 +40,6 @@ public fetch<T> getOriginalFetch() {
     public Set<String> getProxiedProps() {
         return proxiedProps;
     }
-
-    public DomainMetadataAnalyser getDomainMetadataAnalyser() {
-        return domainMetadataAnalyser;
-    }
 
     @Override
     public boolean containsProp(final String propName) {
@@ -108,26 +101,22 @@ public String toString() {
         return sb.toString();
     }
 
-    protected PropertyMetadata getPropMetadata(final String propName) {
-        final PropertyMetadata ppi = domainMetadataAnalyser.getPropPersistenceInfoExplicitly(getEntityType(), propName);
-        if (ppi != null) {
-            if (ppi.getJavaType() != null) {
-                return ppi;
-            } else {
-                throw new EqlException(format("Couldn't determine type of property [%s] of entity type [%s]", propName, getEntityType()));
-            }
-        } else {
+    protected Optional<PropertyMetadata> getPropMetadata(final String propName) {
+        final var optPm = domainMetadata.forPropertyOpt(getEntityType(), propName);
+        if (optPm.isEmpty()) {
+            // allow only IDs and VERSIONs to have missing PropertyMetadata; this is sometimes useful for pure synthetic entities that yield these props
             if (ID.equals(propName) || VERSION.equals(propName)) {
-                return null; // allow only IDs and VERSIONs to have missing PropertyMetadata; this is sometimes useful for pure synthetic entities that yield these props
+                return Optional.empty();
             }
             throw new EqlException(format("Trying to fetch entity of type [%s] with non-existing property [%s]", getEntityType(), propName));
         }
+        return optPm;
     }
 
     protected void without(final String propName) {
-        final Class<?> propType = getPropMetadata(propName).getJavaType();
+        final Optional<PropertyMetadata> optPm = getPropMetadata(propName);
 
-        if (isEntityType(propType)) {
+        if (optPm.map(pm -> pm.type().isEntity()).orElse(FALSE)) {
             final Object removalResult = entityProps.remove(propName);
             if (removalResult == null) {
                 throw new EqlException(format("Couldn't find property [%s] to be excluded from fetched entity properties of entity type [%s]", propName, getEntityType()));
@@ -139,4 +128,4 @@ protected void without(final String propName) {
             }
         }
     }
-}
+}

platform-dao/src/main/java/ua/com/fielden/platform/entity/query/EntityAggregatesRetrievalModel.java

@@ -7,12 +7,12 @@
 import ua.com.fielden.platform.entity.AbstractEntity;
 import ua.com.fielden.platform.entity.query.exceptions.EqlException;
 import ua.com.fielden.platform.entity.query.fluent.fetch;
-import ua.com.fielden.platform.entity.query.metadata.DomainMetadataAnalyser;
+import ua.com.fielden.platform.meta.IDomainMetadata;
 
 public class EntityAggregatesRetrievalModel<T extends AbstractEntity<?>> extends AbstractRetrievalModel<T> {
 
-    public EntityAggregatesRetrievalModel(final fetch<T> originalFetch, final DomainMetadataAnalyser domainMetadataAnalyser) {
-        super(originalFetch, domainMetadataAnalyser, true);
+    public EntityAggregatesRetrievalModel(final fetch<T> originalFetch, final IDomainMetadata domainMetadata) {
+        super(originalFetch, domainMetadata, true);
 
         validateModel();
 
@@ -42,11 +42,11 @@ private void validateModel() {
     private void addEntityPropsModel(final String propName, final fetch<? extends AbstractEntity<?>> fetchModel) {
         final EntityRetrievalModel<?> existingFetch = getRetrievalModels().get(propName);
         fetch<?> finalFetch = existingFetch != null ? existingFetch.originalFetch.unionWith(fetchModel) : fetchModel;
-        addEntityPropFetchModel(propName, new EntityRetrievalModel<>(finalFetch, getDomainMetadataAnalyser(), false));
+        addEntityPropFetchModel(propName, new EntityRetrievalModel<>(finalFetch, domainMetadata, false));
     }
 
     @Override
     public boolean containsOnlyTotals() {
         return false;
     }
-}
+}

platform-dao/src/main/java/ua/com/fielden/platform/entity/query/EntityBatchDeleteByQueryModelOperation.java

@@ -7,9 +7,9 @@
 import ua.com.fielden.platform.dao.exceptions.EntityDeletionException;
 import ua.com.fielden.platform.entity.query.model.AggregatedResultQueryModel;
 import ua.com.fielden.platform.entity.query.model.EntityResultQueryModel;
-import ua.com.fielden.platform.eql.meta.EqlDomainMetadata;
 import ua.com.fielden.platform.eql.stage2.TransformationResultFromStage2To3;
 import ua.com.fielden.platform.eql.stage3.queries.ResultQuery3;
+import ua.com.fielden.platform.meta.IDomainMetadata;
 
 import javax.persistence.PersistenceException;
 import java.util.Collections;
@@ -47,13 +47,13 @@ public <E extends AbstractEntity<?>> int deleteEntities(final EntityResultQueryM
     }
 
     private <T extends AbstractEntity<?>> DeletionModel getModelSql(final EntityResultQueryModel<T> model, final Map<String, Object> paramValues) {
-        final EqlDomainMetadata eqlDomainMetadata = executionContext.getEqlDomainMetadata();
+        final IDomainMetadata domainMetadata = executionContext.getDomainMetadata();
         final AggregatedResultQueryModel finalModel = select(model.getResultType()).where().prop(ID).in().model(model).yield().prop(ID).as(ID).modelAsAggregate();
-        final String tableName = eqlDomainMetadata.entityMetadataHolder.getTableForEntityType(model.getResultType()).name();
-        final TransformationResultFromStage2To3<ResultQuery3> s2tr = transform(new QueryProcessingModel(finalModel, null, null, paramValues, true), null, null, executionContext.dates(), eqlDomainMetadata);
+        final String tableName = domainMetadata.getTableForEntityType(model.getResultType()).name();
+        final TransformationResultFromStage2To3<ResultQuery3> s2tr = transform(new QueryProcessingModel(finalModel, null, null, paramValues, true), null, null, executionContext.dates(), domainMetadata);
         final ResultQuery3 entQuery3 = s2tr.item;
-        final String selectionSql = entQuery3.sql(eqlDomainMetadata);
-        final String deletionSql = produceDeletionSql(selectionSql, tableName, eqlDomainMetadata.dbVersion);
+        final String selectionSql = entQuery3.sql(domainMetadata);
+        final String deletionSql = produceDeletionSql(selectionSql, tableName, domainMetadata.dbVersion());
         return new DeletionModel(deletionSql, s2tr.updatedContext.getSqlParamValues());
     }
 

platform-dao/src/main/java/ua/com/fielden/platform/entity/query/EntityBatchInsertOperation.java

@@ -30,7 +30,7 @@
 import ua.com.fielden.platform.dao.session.TransactionalExecution;
 import ua.com.fielden.platform.entity.AbstractEntity;
 import ua.com.fielden.platform.entity.query.EntityBatchInsertOperation.TableStructForBatchInsertion.PropColumnInfo;
-import ua.com.fielden.platform.eql.meta.EqlDomainMetadata;
+import ua.com.fielden.platform.meta.IDomainMetadata;
 import ua.com.fielden.platform.utils.CollectionUtil;
 import ua.com.fielden.platform.utils.StreamUtils;
 
@@ -47,11 +47,11 @@
  *
  */
 public class EntityBatchInsertOperation {
-    private final EqlDomainMetadata eqlDomainMetadata;
+    private final IDomainMetadata domainMetadata;
     private final Supplier<TransactionalExecution> trExecSupplier;
 
-    public EntityBatchInsertOperation(final EqlDomainMetadata dm, final Supplier<TransactionalExecution> trExecSupplier) {
-        this.eqlDomainMetadata = dm;
+    public EntityBatchInsertOperation(final IDomainMetadata domainMetadata, final Supplier<TransactionalExecution> trExecSupplier) {
+        this.domainMetadata = domainMetadata;
         this.trExecSupplier = trExecSupplier;
     }
 
@@ -87,10 +87,10 @@ public <T extends AbstractEntity<?>> int batchInsert(final List<T> entities, fin
             throw new EntityAlreadyExists("Trying to perform batch insert for persisted entities.");
         }
 
-        final TableStructForBatchInsertion table = eqlDomainMetadata.getTableForEntityType(entities.get(0).getType());
+        final TableStructForBatchInsertion table = domainMetadata.getTableStructsForBatchInsertion(entities.get(0).getType());
         final String tableName = table.name;
         final List<String> columnNames = table.columns.stream().flatMap(x -> x.columnNames().stream()).collect(toList());
-        final String insertStmt = generateInsertStmt(tableName, columnNames, eqlDomainMetadata.dbVersion);
+        final String insertStmt = generateInsertStmt(tableName, columnNames, domainMetadata.dbVersion());
 
         final AtomicInteger insertedCount = new AtomicInteger(0);
 
@@ -174,4 +174,4 @@ public PropColumnInfo(final String leafPropName, final List<String> columnNames,
 
     }
 
-}
+}