Package net.ssehub.easy.instantiation.velocity

Class VelocityInstantiator

java.lang.Object
net.ssehub.easy.instantiation.velocity.VelocityInstantiator
All Implemented Interfaces:
net.ssehub.easy.instantiation.core.model.vilTypes.IRegistration, net.ssehub.easy.instantiation.core.model.vilTypes.IVilType
public class VelocityInstantiator extends Object implements net.ssehub.easy.instantiation.core.model.vilTypes.IVilType, net.ssehub.easy.instantiation.core.model.vilTypes.IRegistration
A VIL instantiator for velocity.
Author:
Holger Eichelberger, Sascha El-Sharkawy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static boolean
    registered
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    VelocityInstantiator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    activate(org.osgi.service.component.ComponentContext context)
    Private method to activate plugin.
    private static final org.apache.velocity.VelocityContext
    createContext(net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config, net.ssehub.easy.instantiation.core.model.vilTypes.Map<?,?> nameMapping)
    Creates the velocity context.
    private static org.apache.velocity.app.VelocityEngine
    createEngine()
    Creates the velocity engine with local configuration.
    protected void
    deactivate(org.osgi.service.component.ComponentContext context)
    Private method to to de-activate plugin.
    private static final net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact
    instantiate(net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact template, org.apache.velocity.app.VelocityEngine engine, org.apache.velocity.VelocityContext context)
    Instantiate a single file artifact.
    static final void
    register()
    Registers the Java artifacts and instantiators.
    static net.ssehub.easy.instantiation.core.model.vilTypes.Set<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact>
    velocity(net.ssehub.easy.instantiation.core.model.artifactModel.Path template, net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config)
    Instantiates a single file artifact using the given configuration.
    static net.ssehub.easy.instantiation.core.model.vilTypes.Set<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact>
    velocity(net.ssehub.easy.instantiation.core.model.artifactModel.Path template, net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config, net.ssehub.easy.instantiation.core.model.vilTypes.Map<?,?> nameMapping)
    Instantiates a single file artifact using the given configuration.
    static net.ssehub.easy.instantiation.core.model.vilTypes.Set<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact>
    velocity(net.ssehub.easy.instantiation.core.model.vilTypes.Collection<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact> templates, net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config)
    Instantiates a collection of file artifacts using the given configuration.
    static net.ssehub.easy.instantiation.core.model.vilTypes.Set<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact>
    velocity(net.ssehub.easy.instantiation.core.model.vilTypes.Collection<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact> templates, net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config, net.ssehub.easy.instantiation.core.model.vilTypes.Map<?,?> nameMapping)
    Instantiates a collection of file artifacts using the given configuration.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • registered

      private static boolean registered

  • Constructor Details

    • VelocityInstantiator

      public VelocityInstantiator()

  • Method Details

    • register

      public static final void register()
      Registers the Java artifacts and instantiators.

    • activate

      protected void activate(org.osgi.service.component.ComponentContext context)
      Private method to activate plugin.
      Parameters:
      context - Context.

    • deactivate

      protected void deactivate(org.osgi.service.component.ComponentContext context)
      Private method to to de-activate plugin.
      Parameters:
      context - Context.

    • velocity

      public static net.ssehub.easy.instantiation.core.model.vilTypes.Set<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact> velocity(net.ssehub.easy.instantiation.core.model.vilTypes.Collection<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact> templates, net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config) throws net.ssehub.easy.instantiation.core.model.common.VilException
      Instantiates a collection of file artifacts using the given configuration.
      Parameters:
      templates - the templates to be instantiated
      config - the configuration to be considered
      Returns:
      the modified artifacts
      Throws:
      net.ssehub.easy.instantiation.core.model.common.VilException - In case that instantiation fails

    • velocity

      public static net.ssehub.easy.instantiation.core.model.vilTypes.Set<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact> velocity(net.ssehub.easy.instantiation.core.model.vilTypes.Collection<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact> templates, net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config, net.ssehub.easy.instantiation.core.model.vilTypes.Map<?,?> nameMapping) throws net.ssehub.easy.instantiation.core.model.common.VilException
      Instantiates a collection of file artifacts using the given configuration.
      Parameters:
      templates - the templates to be instantiated
      config - the configuration to be considered
      nameMapping - an optional mapping from IVML names to names used in the target artifact(s)
      Returns:
      the modified artifacts
      Throws:
      net.ssehub.easy.instantiation.core.model.common.VilException - in case that instantiation fails

    • createEngine

      private static org.apache.velocity.app.VelocityEngine createEngine()
      Creates the velocity engine with local configuration.
      Returns:
      the actual velocity engine instance

    • velocity

      public static net.ssehub.easy.instantiation.core.model.vilTypes.Set<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact> velocity(net.ssehub.easy.instantiation.core.model.artifactModel.Path template, net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config) throws net.ssehub.easy.instantiation.core.model.common.VilException
      Instantiates a single file artifact using the given configuration.
      Parameters:
      template - the template to be instantiated
      config - the configuration to be considered
      Returns:
      the modified artifact
      Throws:
      net.ssehub.easy.instantiation.core.model.common.VilException - in case that instantiation fails

    • velocity

      public static net.ssehub.easy.instantiation.core.model.vilTypes.Set<net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact> velocity(net.ssehub.easy.instantiation.core.model.artifactModel.Path template, net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config, net.ssehub.easy.instantiation.core.model.vilTypes.Map<?,?> nameMapping) throws net.ssehub.easy.instantiation.core.model.common.VilException
      Instantiates a single file artifact using the given configuration.
      Parameters:
      template - the template to be instantiated
      config - the configuration to be considered
      nameMapping - an optional mapping from IVML names to names used in the target artifact(s)
      Returns:
      the modified artifact
      Throws:
      net.ssehub.easy.instantiation.core.model.common.VilException - in case that instantiation fails

    • createContext

      private static final org.apache.velocity.VelocityContext createContext(net.ssehub.easy.instantiation.core.model.vilTypes.configuration.Configuration config, net.ssehub.easy.instantiation.core.model.vilTypes.Map<?,?> nameMapping)
      Creates the velocity context.
      Parameters:
      config - the configuration to create the context from
      nameMapping - an optional mapping from IVML names to names used in the target artifact(s)
      Returns:
      the velocity context

    • instantiate

      private static final net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact instantiate(net.ssehub.easy.instantiation.core.model.artifactModel.FileArtifact template, org.apache.velocity.app.VelocityEngine engine, org.apache.velocity.VelocityContext context) throws net.ssehub.easy.instantiation.core.model.common.VilException
      Instantiate a single file artifact.
      Parameters:
      template - the template to instantiate
      engine - the engine for instantiation
      context - the velocity context
      Returns:
      the created file artifact
      Throws:
      net.ssehub.easy.instantiation.core.model.common.VilException - in case of problems