org.nuiton.topia.templates.ObserveTopiaMetaTransformer Maven / Gradle / Ivy

Go to download
package org.nuiton.topia.templates;

/*
 * #%L
 * ObServe Toolkit :: ToPIA Templates Extension
 * %%
 * Copyright (C) 2008 - 2017 IRD, Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 Public License for more details.
 * 
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import com.google.common.collect.ImmutableSet;
import java.util.List;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuiton.eugene.AbstractMetaTransformer;
import org.nuiton.eugene.models.object.ObjectModel;
import org.nuiton.eugene.models.object.ObjectModelClass;
import org.nuiton.eugene.models.object.validator.AttributeNamesValidator;
import org.nuiton.eugene.models.object.validator.ClassNamesValidator;
import org.nuiton.eugene.models.object.validator.ObjectModelValidator;

/**
 * Created: 20 déc. 2009
 *
 * @author Tony Chemit - [email protected]
 * @plexus.component role="org.nuiton.eugene.Template" role-hint="org.nuiton.topia.templates.ObserveTopiaMetaTransformer"
 */
public class ObserveTopiaMetaTransformer extends AbstractMetaTransformer {

    /** Logger */
    private static final Log log = LogFactory.getLog(TopiaMetaTransformer.class);

    protected static final ImmutableSet FORBIDDEN_ATTRIBUTE_NAMES =
            ImmutableSet.of("analyze", "next", "value", "values", "begin", "end", "authorization",
                            "order", "user");

    protected static final ImmutableSet FORBIDDEN_CLASS_NAMES =
            ImmutableSet.of("constraint", "user");

    public ObserveTopiaMetaTransformer() {

        setTemplateTypes(
                ObserveEntityTransformer.class,
                EntityHibernateMappingGenerator.class,
                EntityDaoTransformer.class,
                EntityEnumTransformer.class,
                ApplicationContextTransformer.class,
                PersistenceContextTransformer.class,
                TopiaMetadataModelGenerator.class
        );

    }

    protected boolean validateModel(ObjectModel model) {

        boolean validationSuccess = true;

        for (ObjectModelValidator validator : getValidators(model)) {
            if (!validator.validate()) {
                for (String error : validator.getErrors()) {
                    if (log.isWarnEnabled()) {
                        log.warn("[VALIDATION] " + error);
                    }
                }
                // TODO brendan 29/08/14 uncomment line below to resolve #3487
                // validationSuccess = false;
            }
        }

        TopiaTemplateHelper templateHelper = new TopiaTemplateHelper(model);

        // test before all if there is some entities to generate
        List classes = templateHelper.getEntityClasses(model, true);

        if (classes.isEmpty()) {
            // no entity to generate, can stop safely
            if (log.isWarnEnabled()) {
                log.warn("No entity to generate, " + getClass().getName() + " is skipped");
            }
            validationSuccess = false;
        }

        return validationSuccess;
    }

    protected ImmutableSet getValidators(ObjectModel model) {

        AttributeNamesValidator attributeNamesValidator = new AttributeNamesValidator(model);
        for (String sqlKeyword : FORBIDDEN_ATTRIBUTE_NAMES) {
            attributeNamesValidator.addNameAndReason(
                    sqlKeyword, "Le nom d'attribut \"" + sqlKeyword + "\" est incompatible avec certains SGBD");
        }

        ClassNamesValidator classNamesValidator = new ClassNamesValidator(model);
        for (String sqlKeyword : FORBIDDEN_CLASS_NAMES) {
            classNamesValidator.addNameAndReason(
                    sqlKeyword, "Le nom de classe \"" + sqlKeyword + "\" est incompatible avec certains SGBD");
        }

        TopiaJavaValidator topiaJavaValidator = new TopiaJavaValidator(model);

        TopiaRelationValidator topiaRelationValidator = new TopiaRelationValidator(model);

        return ImmutableSet.of(attributeNamesValidator, classNamesValidator, topiaJavaValidator, topiaRelationValidator);

    }

}