Added support for Released Transform.

This will merge “object” and “version” tagged entities along with a “release” entity into a single Released entity.

Author: Bob Garner

docs/emc/EMC_domain.md

@@ -11,6 +11,7 @@ Model classes that are domain specific are of this type. The classes are briefly
 |[`MTDEAttribute`](#class_MTDEAttribute)|Represents an attribute in your model in the context of a domain.|
 |[`MTDEAttributeConstraintExpression`](#class_MTDEAttributeConstraintExpression)|Represents a constraint on an attribute in the form of an expression.|
 |[`MTDERelationship`](#class_MTDERelationship)|Represents a relationship in your model in the context of a domain.|
+|[`MTDERelationshipField`](#class_MTDERelationshipField)|Represents a field (attribute or relationship) associated with the __to__ entity of the relationship.|
 |[`MTDEntity`](#class_MTDEntity)|Represents an entity in your model in the context of a domain.|
 |[`MTDEnum`](#class_MTDEnum)|Represents an enum in the context of a domain.|
 |[`MTDEnumItem`](#class_MTDEnumItem)|Represents an enum item in the context of a domain.|
@@ -236,6 +237,12 @@ If this relationship was explicitly renamed within its domain, it will return th
 
 <hr/>
 
+#### `Collection` **`fields`**
+
+Returns all the declared fields of this relationship.
+
+<hr/>
+
 #### `String fullname(String delim)`
 
 This returns the full name of this domain relationship which includes not only its domain based name but is also preceded with the domain's entity's full name. The delimiter can be provided which is used between all parts of the full name.
@@ -551,6 +558,18 @@ Returns the domain specific version of the specified relationship.
 
 <hr/>
 
+#### `boolean` **`hasDeclaredDomainRelationships`**
+
+Indicates if any relationships were declared in this domain entity declaration.
+
+<hr/>
+
+#### `boolean` **`hasParentRelationship`**
+
+Indicates whether this domain entity has a parent relationship. A parent relationship is one that has been declared as `parent`
+
+<hr/>
+
 #### `boolean` **`hasPrimaryParentRelationship`**
 
 Indicates whether this domain entity has a primary parent relationship. A primary parent relationship is one that has been declared as `parent` and **not** declared `optional`.

docs/emc/EMC_entity.md

@@ -355,6 +355,16 @@ These methods relate to an entity.
 
 <hr/>
 
+#### `void addRealm(String realm)`
+
+Adds the entity to a realm.
+
+| Parameter | Description |
+|-----|-----|
+|`String realm` | *no description* |
+
+<hr/>
+
 #### `boolean` **`isDeclaredAsPrimary`**
 
 Indicates whether this entity was **declared** `primary`. If the entity was **not** declared with the `primary` keyword then this will return false even if it is implied as primary.
@@ -379,6 +389,16 @@ Indicates whether this entity was created by the compiler because it represents
 
 <hr/>
 
+#### `boolean isInRealm(String realm)`
+
+Returns true if this entity is part of a realm.
+
+| Parameter | Description |
+|-----|-----|
+|`String realm` | *no description* |
+
+<hr/>
+
 #### `boolean` **`isPrimary`**
 
 Indicates whether this entity was declared `primary` or if it was inferred as primary. If an entity has a primary key it is inferred to be a primary entity.
@@ -848,6 +868,16 @@ Indicates whether this entity has at least one relationship with the specified t
 
 <hr/>
 
+#### `boolean hasRelationshipToEntityNamed(String toEntityName)`
+
+Indicates whether this entity has at least one relationship to a named other entity.
+
+| Parameter | Description |
+|-----|-----|
+|`String toEntityName` | The name of the other entity. |
+
+<hr/>
+
 #### `boolean hasRelationshipToEntityTagged(String tag)`
 
 Indicates whether the entity **to** which a relationship references is tagged with the specified tag.
@@ -924,6 +954,16 @@ Indicates whether this was declared as `extern`.
 
 <hr/>
 
+#### `MTEnumItem item(Long index)`
+
+Returns an item by its index.
+
+| Parameter | Description |
+|-----|-----|
+|`Long index` | *no description* |
+
+<hr/>
+
 #### `List` **`items`**
 
 Gets the enum items.
@@ -1366,6 +1406,12 @@ Indicates whether this type is both an array type and also `byte` data type.
 
 <hr/>
 
+#### `boolean` **`isDataType`**
+
+Indicates whether this type is the `data` data type.
+
+<hr/>
+
 #### `boolean` **`isDateType`**
 
 Indicates whether this type is the `date` data type.

docs/emc/EMC_foundation.md

@@ -75,6 +75,16 @@ Returns the first item in the array.
 
 <hr/>
 
+#### `Object get(Integer index)`
+
+Returns the specified item by its index into the array.
+
+| Parameter | Description |
+|-----|-----|
+|`Integer index` | The index into the array that points to the item to be returned. |
+
+<hr/>
+
 #### `Object get(Long index)`
 
 Returns the specified item by its index into the array.

src/main/java/org/entityc/compiler/ASTVisitor.java

@@ -23,22 +23,7 @@
 import org.entityc.compiler.model.config.MTTemplate;
 import org.entityc.compiler.model.config.MTTransform;
 import org.entityc.compiler.model.domain.*;
-import org.entityc.compiler.model.entity.HalfRelationshipPlurality;
-import org.entityc.compiler.model.entity.MTAttribute;
-import org.entityc.compiler.model.entity.MTAttributeConstraint;
-import org.entityc.compiler.model.entity.MTBitField;
-import org.entityc.compiler.model.entity.MTEntity;
-import org.entityc.compiler.model.entity.MTEntityTemplate;
-import org.entityc.compiler.model.entity.MTEntityTemplateInstantiation;
-import org.entityc.compiler.model.entity.MTEnum;
-import org.entityc.compiler.model.entity.MTEnumItem;
-import org.entityc.compiler.model.entity.MTNativeType;
-import org.entityc.compiler.model.entity.MTPrimaryKey;
-import org.entityc.compiler.model.entity.MTRelationship;
-import org.entityc.compiler.model.entity.MTTagSet;
-import org.entityc.compiler.model.entity.MTTypedef;
-import org.entityc.compiler.model.entity.MTUnit;
-import org.entityc.compiler.model.entity.MTView;
+import org.entityc.compiler.model.entity.*;
 import org.entityc.compiler.model.expression.MTConstant;
 import org.entityc.compiler.model.expression.MTExpression;
 import org.entityc.compiler.model.expression.MTMethodCall;
@@ -1652,6 +1637,7 @@ public Object visitDomainNaming(EntityLanguageParser.DomainNamingContext ctx) {
             } else if (namingClassContext.MODULE() != null) {
                 classesWithNaming.add(MTModule.class);
             } else if (namingClassContext.ENTITY() != null) {
+                classesWithNaming.add(MTCompositeEntity.class);
                 classesWithNaming.add(MTEntity.class);
                 classesWithNaming.add(MTView.class);
             } else if (namingClassContext.ATTRIBUTE() != null) {

src/main/java/org/entityc/compiler/EntityCompiler.java

@@ -24,6 +24,8 @@
 import org.entityc.compiler.repository.RepositoryFile;
 import org.entityc.compiler.repository.RepositoryImportManager;
 import org.entityc.compiler.transform.MTBaseTransform;
+import org.entityc.compiler.transform.MTVImplicitTransform;
+import org.entityc.compiler.transform.MTVReleasedTransform;
 import org.entityc.compiler.transform.TransformManager;
 import org.entityc.compiler.transform.template.FileTemplateTransform;
 import org.entityc.compiler.transform.template.TemplatePublishing;
@@ -132,8 +134,9 @@ public static void RunTransforms(MTRoot root, MTConfiguration configuration) {
         root.resolveReferences(false);
         //model.processAssetAttributes();
         root.getSpace().checkValidReferences();
+        final String ImplicitTransformName = "Implicit";
 
-        TransformManager.GetTransformByName("Implicit").start();
+        TransformManager.GetTransformByName(ImplicitTransformName).start(null);
 
         for (MTTransform transformSpec : configuration.getTransforms()) {
             MTBaseTransform transform = TransformManager.GetTransformByName(transformSpec.getName());
@@ -143,8 +146,10 @@ public static void RunTransforms(MTRoot root, MTConfiguration configuration) {
             if (commandLine.verbose) {
                 System.out.println("Running " + "transform" + " " + transform.getName());
             }
-            transform.start();
+            transform.start(null);
         }
+        MTBaseTransform implicitTransform = TransformManager.GetTransformByName(ImplicitTransformName);
+        ((MTVImplicitTransform)implicitTransform).start(MTVReleasedTransform.realm);
 
         root.resolveReferences(true);
         root.getSpace().checkValidReferences();

src/main/java/org/entityc/compiler/model/domain/MTDEntity.java

@@ -104,6 +104,12 @@ public boolean hasDeclaredDomainAttributes() {
         return declaredDomainAttributes.size() > 0;
     }
 
+    @ModelMethod(category = ModelMethodCategory.RELATIONSHIP,
+        description = "Indicates if any relationships were declared in this domain entity declaration.")
+    public boolean hasDeclaredDomainRelationships() {
+        return declaredDomainRelationships.size() > 0;
+    }
+
     public void addAttribute(MTAttribute attribute) {
         if (entity != null && entity.hasAttributeNamed(attribute.getName())) {
             ECLog.logFatal(attribute, "The entity already has an attribute by the name: " + attribute.getName());
@@ -564,11 +570,18 @@ public MTDEntity primaryParentEntity() {
 
     @ModelMethod(category = ModelMethodCategory.RELATIONSHIP,
         description = "Returns the primary parent relationship of this domain entity. A primary parent "
-                      + "relationship is one that has been declared as `parent` and **not** declared `optional`.")
+            + "relationship is one that has been declared as `parent` and **not** declared `optional`.")
     public MTDERelationship primaryParentRelationship() {
         return getDomainEntityRelationshipByName(entity.getPrimaryParentRelationship().getName(), true);
     }
 
+    @ModelMethod(category = ModelMethodCategory.RELATIONSHIP,
+        description = "Indicates whether this domain entity has a parent relationship. A parent "
+            + "relationship is one that has been declared as `parent`")
+    public boolean hasParentRelationship() {
+        return entity != null && entity.hasParentRelationship();
+    }
+
     public MTDView getDomainEntityViewByName(String viewName, boolean createIfNeeded) {
         MTDView domainEntityView = domainViewMap.get(viewName);
         if (domainEntityView == null && domain.getParentDomain() != null) {

src/main/java/org/entityc/compiler/model/entity/MTAttribute.java

@@ -95,6 +95,9 @@ public MTAttribute(ParserRuleContext ctx, String entityName, String typeName, St
     protected MTAttribute(String secondaryName, MTAttribute primaryAttribute) {
         super(primaryAttribute.getParserRuleContext());
         this.name                        = secondaryName;
+        this.description = primaryAttribute.getDescription();
+        this.setSummary(primaryAttribute.getSummary());;
+        this.setDetail(primaryAttribute.getDetail());;
         this.entityName                  = primaryAttribute.entityName;
         this.entity                      = primaryAttribute.entity;
         this.unit                        = primaryAttribute.unit;

src/main/java/org/entityc/compiler/model/entity/MTCompositeEntity.java

@@ -0,0 +1,42 @@
+package org.entityc.compiler.model.entity;
+
+import org.antlr.v4.runtime.ParserRuleContext;
+import org.entityc.compiler.model.MTModule;
+import org.entityc.compiler.util.ECLog;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class MTCompositeEntity extends MTEntity {
+
+    public static final String ObjectTag = "object";
+    public static final String VersionTag = "version";
+    public static final String ReleaseTag = "release";
+
+    Map<String,MTEntity> constituentEntities = new HashMap<>();
+
+    public MTCompositeEntity(ParserRuleContext ctx, MTModule module, String name) {
+        super(ctx, module, name);
+    }
+
+    private void addConstituentEntity(String tag, MTEntity entity) {
+        if (this.constituentEntities.containsKey(tag) ) {
+            if (!this.constituentEntities.get(tag).name.equals(entity.name)) {
+                ECLog.logFatal("This composite entity " + this.name + " is already associated to a different entity with the " + tag + " tag.");
+            } else {
+                return;
+            }
+        }
+        this.constituentEntities.put(tag, entity);
+    }
+
+    public MTEntity getConstituentEntity(String tag) {
+        return constituentEntities.get(tag);
+    }
+
+    public void addAttribute(String tag, MTAttribute attribute, MTEntity fromEntity) {
+        addConstituentEntity(tag, fromEntity);
+        MTAttribute constituentAttribute = MTAttribute.Copy(attribute, this);
+        super.addAttribute(constituentAttribute);
+    }
+}

src/main/java/org/entityc/compiler/model/entity/MTEntity.java

@@ -21,13 +21,7 @@
 import org.entityc.compiler.util.ECLog;
 import org.entityc.compiler.util.ECStringUtil;
 
-import java.util.ArrayList;
-import java.util.Comparator;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Stack;
-import java.util.Vector;
+import java.util.*;
 import java.util.stream.Collectors;
 
 import static org.entityc.compiler.doc.annotation.ModelMethodCategory.ENTITY_TEMPLATE;
@@ -59,6 +53,7 @@ public class MTEntity extends MTType implements MTReferenceResolution, MTNamed,
     private         int                                      largestFieldNumber        = 0;
     private         MTSpace                                  space;
     private         MTAttribute                              manyAttribute             = null; // if the entity was created from a "many <Entity> attributeName"
+    protected       Set<String>                              realms = new HashSet<>(); // a space entities can live in separate from the others - such as for composite entities
 
     public MTEntity(ParserRuleContext ctx, MTModule module, String name) {
         super(ctx);
@@ -89,6 +84,19 @@ public String getName() {
         return name;
     }
 
+    @ModelMethod(category = ModelMethodCategory.ENTITY,
+        description = "Adds the entity to a realm.")
+    public void addRealm(String realm) {
+        ECLog.logInfo("Added entity: " + getName() + " to realm " + realm);
+        realms.add(realm);
+    }
+
+    @ModelMethod(category = ModelMethodCategory.ENTITY,
+        description = "Returns true if this entity is part of a realm.")
+    public boolean isInRealm(String realm) {
+        return this.realms.contains(realm);
+    }
+
     public static MTEntity AddImplicitManyToManyEntity(MTSpace space, MTEntity fromEntity, MTEntity toEntity) {
         MTEntity combinedEntity       = CombineEntities(fromEntity, toEntity);
         MTEntity alreadyCreatedEntity = space.getEntityWithName(combinedEntity.getName());
@@ -929,7 +937,7 @@ public MTAttribute attributeTagged(
         description = "Indicates whether this entity has at least one relationship with the specified tag.")
     public boolean hasRelationshipTagged(
         @ModelMethodParameter(description = "The tag with which to search.")
-            String tag) {
+        String tag) {
         for (MTRelationship relationship : getRelationships()) {
             if (relationship.hasTag(tag)) {
                 return true;
@@ -938,6 +946,20 @@ public boolean hasRelationshipTagged(
         return false;
     }
 
+    @ModelMethod(
+        category = ModelMethodCategory.TAGGING,
+        description = "Indicates whether this entity has at least one relationship to a named other entity.")
+    public boolean hasRelationshipToEntityNamed(
+        @ModelMethodParameter(description = "The name of the other entity.")
+        String toEntityName) {
+        for (MTRelationship relationship : getRelationships()) {
+            if (relationship.getTo().getEntityName().equals(toEntityName)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     @ModelMethod(
         category = ModelMethodCategory.TAGGING,
         description = "Returns a relationship of this entity that is tagged with the specified tag.")

src/main/java/org/entityc/compiler/model/entity/MTEnum.java

@@ -65,6 +65,10 @@ public int getItemCount() {
         return items.size();
     }
 
+    @ModelMethod(category = ModelMethodCategory.ENUM, description = "Returns an item by its index.")
+    public MTEnumItem getItem(Long index) {
+        return getItem(index.intValue());
+    }
     public MTEnumItem getItem(int index) {
         return items.get(index);
     }