com.querydsl.sql.codegen.AbstractNamingStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of querydsl-sql-codegen Show documentation
SQL codegen support for Querydsl
There is a newer version: 5.1.0
/*
 * Copyright 2015, The Querydsl Team (http://www.querydsl.com/team)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.querydsl.sql.codegen;

import javax.lang.model.SourceVersion;

import com.querydsl.codegen.EntityType;
import com.querydsl.sql.SchemaAndTable;
import com.querydsl.sql.codegen.support.ForeignKeyData;

/**
 * {@code AbstractNamingStrategy} is an abstract base class for {@link NamingStrategy} implementations
 *
 * @author tiwe
 *
 */
public abstract class AbstractNamingStrategy implements NamingStrategy {

    protected String foreignKeysClassName = "ForeignKeys";

    protected String foreignKeysVariable = "fk";

    protected String primaryKeysClassName = "PrimaryKeys";

    protected String primaryKeysVariable = "pk";

    protected String reservedSuffix = "_col";

    @Override
    public String appendSchema(String packageName, String schemaName) {
        if (schemaName == null) {
          return packageName;
        }
        String suffix = schemaName.toLowerCase();
        if (SourceVersion.isKeyword(suffix)) {
            suffix += "_";
        }
        return packageName + "." + suffix;
    }

    protected String escape(EntityType entityType, String name) {
        int suffix = 0;
        while (true) {
            String candidate = suffix > 0 ? name + suffix : name;
            if (entityType.getEscapedPropertyNames().contains(candidate)) {
                suffix++;
            } else {
                return candidate;
            }
        }
    }

    @Override
    public String getForeignKeysClassName() {
        return foreignKeysClassName;
    }

    @Override
    public String getForeignKeysVariable(EntityType entityType) {
        return foreignKeysVariable;
    }

    @Override
    public String getPrimaryKeysClassName() {
        return primaryKeysClassName;
    }

    @Override
    public String getPrimaryKeysVariable(EntityType entityType) {
        return primaryKeysVariable;
    }

    @Override
    public String normalizeColumnName(String columnName) {
        return normalizeSQLName(columnName);
    }

    @Override
    public String normalizeTableName(String tableName) {
        return normalizeSQLName(tableName);
    }

    @Override
    public String normalizeSchemaName(String schemaName) {
        return normalizeSQLName(schemaName);
    }

    protected String normalizeSQLName(String name) {
        if (name != null) {
            return name.replaceAll("\r", "").replaceAll("\n", " ");
        } else {
            return null;
        }
    }

    protected String normalizeJavaName(String name) {
        return Naming.normalize(name, reservedSuffix);
    }

    public void setForeignKeysClassName(String foreignKeysClassName) {
        this.foreignKeysClassName = foreignKeysClassName;
    }

    public void setForeignKeysVariable(String foreignKeysVariable) {
        this.foreignKeysVariable = foreignKeysVariable;
    }

    public void setPrimaryKeysClassName(String primaryKeysClassName) {
        this.primaryKeysClassName = primaryKeysClassName;
    }

    public void setPrimaryKeysVariable(String primaryKeysVariable) {
        this.primaryKeysVariable = primaryKeysVariable;
    }

    public void setReservedSuffix(String reservedSuffix) {
        this.reservedSuffix = reservedSuffix;
    }

    @Override
    public String getPackage(String basePackage, SchemaAndTable schemaAndTable) {
        return appendSchema(basePackage, schemaAndTable.getSchema());
    }

    @Override
    public boolean shouldGenerateClass(SchemaAndTable schemaAndTable) {
        return true;
    }

    @Override
    public boolean shouldGenerateForeignKey(SchemaAndTable schemaAndTable,
        ForeignKeyData foreignKeyData) {
        return true;
    }

    @Override
    public String getClassName(SchemaAndTable schemaAndTable) {
        return getClassName(schemaAndTable.getTable());
    }

}