MetaFactory.io Tech Docs

This site offers technical documentation for users of the MetaFactory Code Composer platform. For ease of access we distinguish 4 information types:

1. Background

   Understanding oriented: offers general information on Metafactory concepts. Explains broad topics and their connections.

2. Tutorials

   Learning oriented: these are dedicated lessons.

3. How-To Guides

   Solution-oriented. Explain how to carry out a certain task.

4. Blogs

   Personal experience

5. Reference

   Information oriented. To-the-point technical descriptions of MetaFactory implementations.

In addition to these four comprehensive chapters we offer a Download page and Glossary.

Contents

• 1. Background
  • 1.1. Why MetaFactory?
    • 1.1.1. What do Developers need?
    • 1.1.2. The conventional way of development
  • 1.2. Automating the software production
    • 1.2.1. Automation, in which case?
  • 1.3. MetaFactory Code Composer, what is it?
    • 1.3.1. Developing with the Composer
    • 1.3.2. The Real Power
    • 1.3.3. The Big Benefit
    • 1.3.4. And what’s in it for you, as a developer?
  • 1.4. Patterns
  • 1.5. The MetaFactory Platform
    • 1.5.1. Trend
    • 1.5.2. Proposition MetaFactory
  • 1.6. MetaFactory process overview
    • 1.6.1. Conventional development process
    • 1.6.2. Development with MetaFactory
    • 1.6.3. Diversify
    • 1.6.4. Reuse
    • 1.6.5. Building a Code Instruction
    • 1.6.6. Metadata - Interaction between MetaModel and Code Instruction
  • 1.7. MetaFactory Project Structure
    • 1.7.1. Project configuration
    • 1.7.2. MetaModel
    • 1.7.3. Code instructions
    • 1.7.4. Properties (optional)
    • 1.7.5. Naming
• 2. Tutorials
  • 2.1. T00 Setup Project
    • 2.1.1. Get the Metafactory environment up and running
    • 2.1.2. Get started
  • 2.2. T01 Hello World
  • 2.3. T02 Create a Class
  • 2.4. T03 Create a Constructor
  • 2.5. T04 Create a Snippet
  • 2.6. T05 Foreach Object
• 3. How-To Guides
  • 3.1. Get and install MetaFactory environment
    • 3.1.1. MetaFactory on Windows
    • 3.1.2. MetaFactory on OSX/MacOS
  • 3.2. Configuring your IDE
    • 3.2.1. Configuring Eclipse
      • 3.2.1.1. Plugins
      • 3.2.1.2. XML Catalog
      • 3.2.1.3. Code fragments for Freemarker
    • 3.2.2. Configuring IntelliJ IDEA
      • 3.2.2.1. Installing and configuring IntelliJ IDEA plugin
      • 3.2.2.2. Resolving XML errors
      • 3.2.2.3. Live Templates
      • 3.2.2.4. Implicit objects in Freemarker or Velocity templates
  • 3.3. QuickStart
    • 3.3.1. Create your first example
    • 3.3.2. Evaluation
  • 3.4. Building a Code Instruction
  • 3.5. How to use snippets
  • 3.6. SDA example using snippets
    • 3.6.1. Code Instruction
    • 3.6.2. Model
    • 3.6.3. Project
    • 3.6.4. Phone class created
    • 3.6.5. Freemarker snippet
    • 3.6.6. Evaluation
  • 3.7. Features and how to use them
    • 3.7.1. Implementation of a Feature - General
    • 3.7.2. Drag & Drop
    • 3.7.3. User Preferences
      • 3.7.3.1. Files
      • 3.7.3.2. Developer notes
  • 3.8. How to preserve manual changes in generated code
• 4. Blogs
  • 4.1. Pojo Classes
    • 4.1.1. Data model
    • 4.1.2. Code instruction
    • 4.1.3. Functions
    • 4.1.4. Methods
  • 4.2. Equals and hashCode
    • 4.2.1. Freemarker snippets
    • 4.2.2. Control over the generation process
    • 4.2.3. CodeComposer and metadata
    • 4.2.4. Alternative equals and hashCode implementations
  • 4.3. Repository
    • 4.3.1. Enrich a POJO with JPA
    • 4.3.2. Repository implementation
    • 4.3.3. Variables
  • 4.4. Organizing code instructions
    • 4.4.1. Multiple code instructions creating one Java class
    • 4.4.2. Features
    • 4.4.3. toString
• 5. Reference
  • 5.1. Project Reference
    • 5.1.1. Structure of the project file
      • 5.1.1.1. Model
      • 5.1.1.2. Pattern
      • 5.1.1.3. Snippets Folder
      • 5.1.1.4. Output
      • 5.1.1.5. BuildSets
      • 5.1.1.6. Maps
        • 5.1.1.6.1. Examples
      • 5.1.1.7. Property Files
        • 5.1.1.7.1. Example
      • 5.1.1.8. Configuration
      • 5.1.1.9. BusinessStyle
  • 5.2. Model Reference
    • 5.2.1. Model structure
    • 5.2.2. Child elements
      • 5.2.2.1. Package
      • 5.2.2.2. Object
      • 5.2.2.3. Attribute
      • 5.2.2.4. Reference
      • 5.2.2.5. Metadata
  • 5.3. Model API Reference
    • 5.3.1. Available context objects
      • 5.3.1.1. Model API Model Root
        • 5.3.1.1.1. Overview
        • 5.3.1.1.2. Details
          • 5.3.1.1.2.1. addMetaData(String key, String value)
          • 5.3.1.1.2.2. addMetaData(String key, String value, String description)
          • 5.3.1.1.2.3. findMetaDataByKey(String expression)
          • 5.3.1.1.2.4. getChilderen()
          • 5.3.1.1.2.5. getFileComment()
          • 5.3.1.1.2.6. getKind()
          • 5.3.1.1.2.7. getMetaData()
          • 5.3.1.1.2.8. getMetaData(String metaDataKey)
          • 5.3.1.1.2.9. getMetaData(String metaDataKey, boolean throwExceptionIfNotFound)
          • 5.3.1.1.2.10. getMetaData(String metaDataKey, String defaultValue)
          • 5.3.1.1.2.11. getName()
          • 5.3.1.1.2.12. getParent()
          • 5.3.1.1.2.13. getText()
          • 5.3.1.1.2.14. hasMetaData(String key)
          • 5.3.1.1.2.15. hasMetaData(String key, String value)
          • 5.3.1.1.2.16. setFileComment(String fileComment)
          • 5.3.1.1.2.17. setName(String name)
      • 5.3.1.2. Model API Model Package
        • 5.3.1.2.1. Overview
        • 5.3.1.2.2. Details
          • 5.3.1.2.2.1. deleteFromObjects(ModelObject objects)
          • 5.3.1.2.2.2. findMetaDataByKey(String expression)
          • 5.3.1.2.2.3. findObjectByMetaData(String key)
          • 5.3.1.2.2.4. findObjectByMetaData(String key, String value)
          • 5.3.1.2.2.5. findObjectByName(String objectName)
          • 5.3.1.2.2.6. findObjectsByMetaData(String key)
          • 5.3.1.2.2.7. findObjectsByMetaData(String key, String value)
          • 5.3.1.2.2.8. getChilderen()
          • 5.3.1.2.2.9. getFileComment()
          • 5.3.1.2.2.10. getKind()
          • 5.3.1.2.2.11. getMetaData()
          • 5.3.1.2.2.12. getMetaData(String metaDataKey)
          • 5.3.1.2.2.13. getMetaData(String metaDataKey, boolean throwExceptionIfNotFound)
          • 5.3.1.2.2.14. getMetaData(String metaDataKey, String defaultValue)
          • 5.3.1.2.2.15. getName()
          • 5.3.1.2.2.16. getObjects()
          • 5.3.1.2.2.17. getParent()
          • 5.3.1.2.2.18. getRoot()
          • 5.3.1.2.2.19. getText()
          • 5.3.1.2.2.20. hasMetaData(String key)
          • 5.3.1.2.2.21. hasMetaData(String key, String value)
      • 5.3.1.3. Model API Model Object
        • 5.3.1.3.1. Overview
        • 5.3.1.3.2. Details
          • 5.3.1.3.2.1. addMetaData(String key, String value)
          • 5.3.1.3.2.2. addMetaData(String key, String value, String description)
          • 5.3.1.3.2.3. addToAttributes(ModelAttribute attributes)
          • 5.3.1.3.2.4. addToReferences(ModelReference references)
          • 5.3.1.3.2.5. deleteFromAttributes(ModelAttribute attributes)
          • 5.3.1.3.2.6. deleteFromReferences(ModelReference references)
          • 5.3.1.3.2.7. findAttributeByMetaData(String key)
          • 5.3.1.3.2.8. findAttributeByMetaData(String key, String value)
          • 5.3.1.3.2.9. findAttributeByName(String attributeName)
          • 5.3.1.3.2.10. findAttributeByType(String attributeType)
          • 5.3.1.3.2.11. findAttributesByMetaData(String key)
          • 5.3.1.3.2.12. findAttributesByMetaData(String key, String value)
          • 5.3.1.3.2.13. findAttributesByType(String attributeType)
          • 5.3.1.3.2.14. findMetaDataByKey(String expression)
          • 5.3.1.3.2.15. findReferenceByMetaData(String key)
          • 5.3.1.3.2.16. findReferenceByMetaData(String key, String value)
          • 5.3.1.3.2.17. findReferenceByName(String referenceName)
          • 5.3.1.3.2.18. findReferenceByType(String referenceType)
          • 5.3.1.3.2.19. findReferencesByMetaData(String key)
          • 5.3.1.3.2.20. findReferencesByMetaData(String key, String value)
          • 5.3.1.3.2.21. findReferencesByMultiplicity(String referenceMultiplicity)
          • 5.3.1.3.2.22. findReferencesByType(String referenceType)
          • 5.3.1.3.2.23. getAttributes()
          • 5.3.1.3.2.24. getAttributeValue(String attributeName)
          • 5.3.1.3.2.25. getFileComment()
          • 5.3.1.3.2.26. getKind()
          • 5.3.1.3.2.27. getMetaData()
          • 5.3.1.3.2.28. getMetaData(String metaDataKey)
          • 5.3.1.3.2.29. getMetaData(String metaDataKey, boolean throwExceptionIfNotFound)
          • 5.3.1.3.2.30. getMetaData(String metaDataKey, String defaultValue)
          • 5.3.1.3.2.31. getModelPackage()
          • 5.3.1.3.2.32. getName()
          • 5.3.1.3.2.33. getReferences()
          • 5.3.1.3.2.34. hasMetaData(String key)
          • 5.3.1.3.2.35. hasMetaData(String key, String value)
          • 5.3.1.3.2.36. setAttributes(List attributes)
          • 5.3.1.3.2.37. setFileComment(String fileComment)
          • 5.3.1.3.2.38. setModelPackage(ModelPackage modelPackage)
          • 5.3.1.3.2.39. setName(String name)
          • 5.3.1.3.2.40. setReferences(List references)
      • 5.3.1.4. Model API Model Attribute
        • 5.3.1.4.1. Overview
        • 5.3.1.4.2. Details
          • 5.3.1.4.2.1. addMetaData(String key, String value)
          • 5.3.1.4.2.2. addMetaData(String key, String value, String description)
          • 5.3.1.4.2.3. findMetaDataByKey(String expression)
          • 5.3.1.4.2.4. getAttributeValue(String attributeName)
          • 5.3.1.4.2.5. getFileComment()
          • 5.3.1.4.2.6. getKind()
          • 5.3.1.4.2.7. getLength()
          • 5.3.1.4.2.8. getMetaData()
          • 5.3.1.4.2.9. getMetaData(String metaDataKey)
          • 5.3.1.4.2.10. getMetaData(String metaDataKey, boolean throwExceptionIfNotFound)
          • 5.3.1.4.2.11. getMetaData(String metaDataKey, String defaultValue)
          • 5.3.1.4.2.12. getName()
          • 5.3.1.4.2.13. getNotnull()
          • 5.3.1.4.2.14. getObject()
          • 5.3.1.4.2.15. getType()
          • 5.3.1.4.2.16. hasMetaData(String key)
          • 5.3.1.4.2.17. hasMetaData(String key, String value)
          • 5.3.1.4.2.18. setFileComment(String fileComment)
          • 5.3.1.4.2.19. setLength(Integer length)
          • 5.3.1.4.2.20. setName(String name)
          • 5.3.1.4.2.21. setNotnull(Boolean notnull)
          • 5.3.1.4.2.22. setObject(ModelObject object)
          • 5.3.1.4.2.23. setType(String type)
      • 5.3.1.5. Model API Model Reference
        • 5.3.1.5.1. Overview
        • 5.3.1.5.2. Details
          • 5.3.1.5.2.1. addMetaData(String key, String value)
          • 5.3.1.5.2.2. addMetaData(String key, String value, String description)
          • 5.3.1.5.2.3. findMetaDataByKey(String expression)
          • 5.3.1.5.2.4. getFileComment()
          • 5.3.1.5.2.5. getKind()
          • 5.3.1.5.2.6. getLength()
          • 5.3.1.5.2.7. getMetaData()
          • 5.3.1.5.2.8. getMetaData(String metaDataKey)
          • 5.3.1.5.2.9. getMetaData(String metaDataKey, boolean throwExceptionIfNotFound)
          • 5.3.1.5.2.10. getMetaData(String metaDataKey, String defaultValue)
          • 5.3.1.5.2.11. getMultiplicity()
          • 5.3.1.5.2.12. getName()
          • 5.3.1.5.2.13. getNotnull()
          • 5.3.1.5.2.14. getObject()
          • 5.3.1.5.2.15. getType()
          • 5.3.1.5.2.16. hasMetaData(String key)
          • 5.3.1.5.2.17. hasMetaData(String key, String value)
          • 5.3.1.5.2.18. setFileComment(String fileComment)
          • 5.3.1.5.2.19. setLength(Integer length)
          • 5.3.1.5.2.20. setMultiplicity()
          • 5.3.1.5.2.21. setName(String name)
          • 5.3.1.5.2.22. setNotnull(Boolean notnull)
          • 5.3.1.5.2.23. setObject(ModelObject object)
          • 5.3.1.5.2.24. setType(String type)
    • 5.3.2. Model hierarchy
  • 5.4. Code Instructions in XML
    • 5.4.1. Introduction
      • 5.4.1.1. Namespaces
      • 5.4.1.2. The root element
      • 5.4.1.3. Child elements
        • 5.4.1.3.1. Generic elements
        • 5.4.1.3.2. Java elements
      • 5.4.1.4. Complement XML patterns with snippets
      • 5.4.1.5. Code instruction base
    • 5.4.2. Java Code Instruction Elements
      • 5.4.2.1. Java package
      • 5.4.2.2. Interface
      • 5.4.2.3. Class
      • 5.4.2.4. Field
      • 5.4.2.5. Method
        • 5.4.2.5.1. Parameter
        • 5.4.2.5.2. Exception
      • 5.4.2.6. Import
      • 5.4.2.7. External libraries
      • 5.4.2.8. External Java package
    • 5.4.3. TypeScript Instruction Elements
    • 5.4.4. XML files
    • 5.4.5. Text files (plain files)
  • 5.5. Code Instructions with snippets
    • 5.5.1. Lots of added flexibility
    • 5.5.2. How to use it
  • 5.6. Code instructions
    • 5.6.1. foreach=”attribute.all”
    • 5.6.2. foreach=”reference”
    • 5.6.3. foreach=”reference1”
    • 5.6.4. foreach=”referenceN”
    • 5.6.5. foreach=”reference.all”
  • 5.7. Expression Language
    • 5.7.1. Functions
      • 5.7.1.1. Built-in Functions
        • 5.7.1.1.1. String functions
          • 5.7.1.1.1.1. allLower
          • 5.7.1.1.1.2. allUpper
          • 5.7.1.1.1.3. camelCaseToTitleFormat
          • 5.7.1.1.1.4. camelToAllUpperUnderscore
          • 5.7.1.1.1.5. camelToKebabCase
          • 5.7.1.1.1.6. camelToSnakeCase
          • 5.7.1.1.1.7. firstLower
          • 5.7.1.1.1.8. firstUpper
        • 5.7.1.1.2. Metadata functions
        • 5.7.1.1.3. Miscellaneous Functions
      • 5.7.1.2. Custom Functions
        • 5.7.1.2.1. Adding a function library with custom functions to the code instructions
        • 5.7.1.2.2. Defining a custom function
        • 5.7.1.2.3. Example of custom functions
        • 5.7.1.2.4. Usage of a custom function
        • 5.7.1.2.5. Usage of a custom function in a code instruction
        • 5.7.1.2.6. Usage of a custom function in a snippet
    • 5.7.2. Variables
    • 5.7.3. Data type mappings
  • 5.8. CodeComposer Directives
    • 5.8.1. CodeComposer:preserve:file
    • 5.8.2. CodeComposer:preserve:field
    • 5.8.3. CodeComposer:preserve:method
    • 5.8.4. CodeComposer:autopreserved:field
    • 5.8.5. CodeComposer:autopreserved:method
  • 5.9. Template engines
    • 5.9.1. Freemarker and Velocity Context Variables
    • 5.9.2. Freemarker settings
    • 5.9.3. Freemarker context object: metafactory
    • 5.9.4. Freemarker context object: context
    • 5.9.5. Freemarker context object: comparatorFactory
    • 5.9.6. Velocity settings
    • 5.9.7. Velocity Functions
      • 5.9.7.1. Call by using the $metafactory context variable
      • 5.9.7.2. Call by using the $context context variable
      • 5.9.7.3. Call by using the $sxmiFactory context variable
      • 5.9.7.4. Best practices and lines you often need
  • 5.10. Technology stack
    • 5.10.1. Liquibase
      • 5.10.1.1. Purpose
      • 5.10.1.2. Website
      • 5.10.1.3. Buildsets involved
      • 5.10.1.4. Usage
  • 5.11. Code
    • 5.11.1. codecomposer-reference-input
      • 5.11.1.1. src
        • 5.11.1.1.1. codeinstruction
          • 5.11.1.1.1.1. examples
            • 5.11.1.1.1.1.1. example-code-instruction-simple-entity-foreach-attribute-all.xml
            • 5.11.1.1.1.1.2. example-code-instruction-simple-entity-foreach-attribute-and-attribute-has-meta-data-with-value.xml
            • 5.11.1.1.1.1.3. example-code-instruction-simple-entity-foreach-attribute-and-attribute-has-meta-data.xml
            • 5.11.1.1.1.1.4. example-code-instruction-simple-entity-foreach-attribute-and-get-meta-data-from-attribute.xml
            • 5.11.1.1.1.1.5. example-code-instruction-simple-entity-foreach-attribute.xml
            • 5.11.1.1.1.1.6. example-code-instruction-simple-entity-foreach-object-and-get-meta-data-from-object.xml
            • 5.11.1.1.1.1.7. example-code-instruction-simple-entity-foreach-object.xml
            • 5.11.1.1.1.1.8. example-code-instruction-simple-entity-foreach-reference-and-reference-has-meta-data-with-value.xml
            • 5.11.1.1.1.1.9. example-code-instruction-simple-entity-foreach-reference-and-reference-has-meta-data.xml
            • 5.11.1.1.1.1.10. example-code-instruction-simple-entity-foreach-reference.xml
            • 5.11.1.1.1.1.11. example-code-instruction-simple-entity-foreach-reference1.xml
            • 5.11.1.1.1.1.12. example-code-instruction-simple-entity-foreach-referenceN.xml
            • 5.11.1.1.1.1.13. example-code-instruction-simple-service-object-has-meta-data.xml
            • 5.11.1.1.1.1.14. example-code-instruction-special-service-object-has-meta-data-with-value.xml
          • 5.11.1.1.1.2. codeinstruction.xml
          • 5.11.1.1.1.3. example-custom-functions.xml
          • 5.11.1.1.1.4. my-project-ci-functions.xml
        • 5.11.1.1.2. model
          • 5.11.1.1.2.1. model.xml
        • 5.11.1.1.3. snippet
          • 5.11.1.1.3.1. examples
            • 5.11.1.1.3.1.1. exampleCommentForReference.ftl
            • 5.11.1.1.3.1.2. exampleCommentForReference1.ftl
            • 5.11.1.1.3.1.3. exampleCommentForReferenceN.ftl
            • 5.11.1.1.3.1.4. exampleCommentForReferenceThatHasMetaDataBar.ftl
            • 5.11.1.1.3.1.5. exampleCommentForReferenceThatHasMetaDataBarWithValueBaz.ftl
            • 5.11.1.1.3.1.6. exampleSnippetToCreateSpecialServiceClassName.ftl
            • 5.11.1.1.3.1.7. exampleSnippetUsingCustomFunction.ftl
          • 5.11.1.1.3.2. function
            • 5.11.1.1.3.2.1. entity
              • 5.11.1.1.3.2.1.1. create_entity_package_name.ftl
          • 5.11.1.1.3.3. library
            • 5.11.1.1.3.3.1. entity
              • 5.11.1.1.3.3.1.1. create_entity_package_name.ftl
            • 5.11.1.1.3.3.2. custom_functions_libproject.ftl
          • 5.11.1.1.3.4. freemarker_implicit.ftl
          • 5.11.1.1.3.5. velocity_implicit.vm
      • 5.11.1.2. codecomposer-reference-input.iml
      • 5.11.1.3. local.properties
      • 5.11.1.4. metafactory.xml
      • 5.11.1.5. template.properties
    • 5.11.2. codecomposer-reference-output
      • 5.11.2.1. src
        • 5.11.2.1.1. main
          • 5.11.2.1.1.1. java
            • 5.11.2.1.1.1.1. io
              • 5.11.2.1.1.1.1.1. metafactory
                • 5.11.2.1.1.1.1.1.1. codecomposer_reference
                  • 5.11.2.1.1.1.1.1.1.1. dtos
                  • 5.11.2.1.1.1.1.1.1.2. entities
                  • 5.11.2.1.1.1.1.1.1.3. services
      • 5.11.2.2. codecomposer-reference-output.iml
• 6. Downloads and links
• 7. Glossary