com.genericworkflownodes.knime.nodegeneration.templates.feature.FeatureXMLTemplate.java Source code

Introduction

Here is the source code for com.genericworkflownodes.knime.nodegeneration.templates.feature.FeatureXMLTemplate.java

Source

package com.genericworkflownodes.knime.nodegeneration.templates.feature;

import java.io.IOException;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.lang.StringEscapeUtils;

import com.genericworkflownodes.knime.nodegeneration.NodeGenerator;
import com.genericworkflownodes.knime.nodegeneration.model.meta.ContributingPluginMeta;
import com.genericworkflownodes.knime.nodegeneration.model.meta.FeatureMeta;
import com.genericworkflownodes.knime.nodegeneration.model.meta.FragmentMeta;
import com.genericworkflownodes.knime.nodegeneration.model.meta.GeneratedPluginMeta;
import com.genericworkflownodes.knime.nodegeneration.templates.Template;

/**
 * Template file for the feature.xml file of the feature.
 * 
 * @author aiche
 */
public class FeatureXMLTemplate extends Template {

    private final static Pattern VERSION_PATTERN = Pattern.compile("^(\\d+)(\\.\\d+)?(\\.\\d+)?(.[a-zA-Z0-9]+)?$");

    private String findLatestQualifier(String pluginQualifier, List<FragmentMeta> fragmentMetas,
            List<ContributingPluginMeta> contributingPluginMetas) {

        String highestQualifier = "";
        if (pluginQualifier != null)
            highestQualifier = pluginQualifier;

        for (FragmentMeta fMeta : fragmentMetas) {
            Matcher m = matchVersion(fMeta.getVersion());
            if (m.group(4) != null && m.group(4).compareTo(highestQualifier) > 0) {
                highestQualifier = m.group(4);
            }
        }

        for (ContributingPluginMeta cMeta : contributingPluginMetas) {
            Matcher m = matchVersion(cMeta.getVersion());
            if (m.group(4) != null && m.group(4).compareTo(highestQualifier) > 0) {
                highestQualifier = m.group(4);
            }

        }

        return highestQualifier;
    }

    public FeatureXMLTemplate(GeneratedPluginMeta pluginMeta, FeatureMeta featureMeta,
            List<FragmentMeta> fragmentMetas, List<ContributingPluginMeta> contributingPluginMetas)
            throws IOException {
        super(NodeGenerator.class.getResourceAsStream("templates/feature/feature.xml.template"));

        replace("@@pluginName@@", pluginMeta.getName());

        // we will ensure that the version ends with a qualifier to make sure
        // that the qualifier is properly updated when something changes
        Matcher m = matchVersion(pluginMeta.getVersion());

        // assemble a complete version
        String newVersion = m.group(1) + (m.group(2) != null ? m.group(2) : ".0")
                + (m.group(3) != null ? m.group(3) : ".0")
                + findLatestQualifier(m.group(4), fragmentMetas, contributingPluginMetas);

        replace("@@pluginVersion@@", newVersion);
        replace("@@packageName@@", pluginMeta.getPackageRoot());

        replace("@@description@@", StringEscapeUtils.escapeXml(featureMeta.getDescription()));
        replace("@@copyright@@", StringEscapeUtils.escapeXml(featureMeta.getCopyright()));
        replace("@@license@@", StringEscapeUtils.escapeXml(featureMeta.getLicense()));

        registerGeneratedPlugin(pluginMeta);
        registerFragments(fragmentMetas);
        registerContributingPlugins(contributingPluginMetas);
    }

    private Matcher matchVersion(final String version) {
        Matcher m = VERSION_PATTERN.matcher(version);

        // via definition this has to be true
        boolean found = m.find();
        assert found : "Version should be compliant to the pattern ^(\\d+)(\\.\\d+)?(\\.\\d+)?(.[a-zA-Z0-9-_]+)?$";
        assert m.groupCount() == 4 : "Something went wrong when matching the version.";

        return m;
    }

    private void registerGeneratedPlugin(GeneratedPluginMeta pluginMeta) {
        String pluginList = String.format("\t<plugin\n" + "\t\tid=\"%s\"\n" + "\t\tdownload-size=\"0\"\n"
                + "\t\tinstall-size=\"0\"\n" + "\t\tversion=\"0.0.0\"\n" + "\t\tunpack=\"false\"/>\n\n",
                pluginMeta.getId());

        replace("@@PLUGIN@@", pluginList);
    }

    private void registerFragments(List<FragmentMeta> fragmentMetas) {
        String fragmentList = "";
        for (FragmentMeta fragmentMeta : fragmentMetas) {
            fragmentList += String.format(
                    "\t<plugin id=\"%s\"\n" + "\t\tos=\"%s\"\n" + "\t\tarch=\"%s\"\n" + "\t\tdownload-size=\"0\"\n"
                            + "\t\tinstall-size=\"0\"\n" + "\t\tversion=\"0.0.0\"\n"
                            + "\t\tfragment=\"true\"/>\n\n",
                    fragmentMeta.getId(), fragmentMeta.getOs().toOsgiOs(), fragmentMeta.getArch().toOsgiArch());
        }

        replace("@@FRAGMENTS@@", fragmentList);
    }

    private void registerContributingPlugins(List<ContributingPluginMeta> contributingPluginMetas) {
        String contributingPluginList = "";
        for (ContributingPluginMeta contributingPluginMeta : contributingPluginMetas) {
            contributingPluginList += String.format(
                    "\t<plugin\n" + "\t\tid=\"%s\"\n" + "\t\tdownload-size=\"0\"\n" + "\t\tinstall-size=\"0\"\n"
                            + "\t\tversion=\"0.0.0\"\n" + "\t\tunpack=\"false\"/>\n\n",
                    contributingPluginMeta.getId());
        }

        replace("@@CONTRIBUTING_PLUGINS@@", contributingPluginList);
    }
}