org.nuiton.eugene.ModelHelper Maven / Gradle / Ivy

Go to download
package org.nuiton.eugene;

/*
 * #%L
 * EUGene :: EUGene Core
 * %%
 * Copyright (C) 2004 - 2017 Code Lutin, Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.util.Collections;
import java.util.Map;
import org.nuiton.eugene.models.Model;
import org.nuiton.eugene.models.object.reader.FriendObjectModelReader;
import org.nuiton.eugene.models.object.reader.XmlObjectModelReader;
import org.nuiton.eugene.models.object.reader.YamlObjectModelReader;
import org.nuiton.eugene.models.state.StateModelReader;

/**
 * Help methods around model.
 *
 * @author Tony Chemit - [email protected]
 * @since 2.6.3
 */
public class ModelHelper {

    /**
     * All available models (obtain by plexus, keys are plexus roles,
     * values are a instance of corresponding model).
     */
    protected Map models;

    /** All available writers introspects via plexus. */
    protected Map> modelReaders;

    public ModelHelper(Map models,
                       Map> modelReaders) {
        this.models = Collections.unmodifiableMap(models);
        this.modelReaders = Collections.unmodifiableMap(modelReaders);
    }

    public Model getModel(String modelType) {
        Model model = models.get(modelType.trim());
        return model;
    }

    public ModelReader getModelReader(String modelType, String type) {
        ModelReader result = null;
        for (ModelReader modelReader : modelReaders.values()) {
            if (modelType.equals(modelReader.getModelType()) &&
                type.equals(modelReader.getInputType())) {
                result = modelReader;
                break;
            }
        }
        return result;
    }

    public Map> getModelReaders() {
        return modelReaders;
    }

    /**
     * Define type of model known by eugene
     *
     * @author Tony Chemit - [email protected]
     * @since 2.6.3
     */
    public enum ModelType {

        /**
         * Object model.
         *
         * @see org.nuiton.eugene.models.object
         */
        OBJECT("objectmodel"),

        /**
         * Object model.
         *
         * @see org.nuiton.eugene.models.state
         */
        STATE("statemodel");

        private final String alias;

        ModelType(String alias) {
            this.alias = alias;
        }

        public String getAlias() {
            return alias;
        }
    }

    /**
     * Define type onf input model known by eugene.
     *
     * @author Tony Chemit - [email protected]
     * @since 2.6.3
     */
    public enum ModelInputType {

        /**
         * Read object model from xml files.
         *
         * @see XmlObjectModelReader
         * @see StateModelReader
         */
        XML("xml"),

        /**
         * Read object model from yaml files.
         *
         * @see YamlObjectModelReader
         */
        YAML("yaml"),
        /**
         * Read object model from friend files.
         *
         * @see FriendObjectModelReader
         */
        FRIEND("friend");

        private final String alias;

        ModelInputType(String alias) {
            this.alias = alias;
        }

        public String getAlias() {
            return alias;
        }

    }
}