com.manydesigns.portofino.model.database.PrimaryKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of portofino-database Show documentation
There is a newer version: 5.3.4
/*
 * Copyright (C) 2005-2015 ManyDesigns srl.  All rights reserved.
 * http://www.manydesigns.com/
 *
 * This 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 software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package com.manydesigns.portofino.model.database;

import com.manydesigns.elements.annotations.Required;
import com.manydesigns.portofino.model.Model;
import com.manydesigns.portofino.model.ModelObject;
import com.manydesigns.portofino.model.ModelObjectVisitor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.*;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;

/*
* @author Paolo Predonzani     - [email protected]
* @author Angelo Lupo          - [email protected]
* @author Giampiero Granatella - [email protected]
* @author Alessio Stalla       - [email protected]
*/

@XmlAccessorType(value = XmlAccessType.NONE)
public class PrimaryKey implements ModelObject {
    public static final String copyright =
            "Copyright (c) 2005-2015, ManyDesigns srl";

    //**************************************************************************
    // Fields
    //**************************************************************************

    protected final List primaryKeyColumns;

    protected Table table;
    protected String primaryKeyName;

    //**************************************************************************
    // Fields for wire-up
    //**************************************************************************

    protected final List columns;
    protected boolean valid;

    public static final Logger logger = LoggerFactory.getLogger(Table.class);

    //**************************************************************************
    // Constructors and wire up
    //**************************************************************************

    public PrimaryKey() {
        columns = new ArrayList();
        primaryKeyColumns = new ArrayList();
    }

    public PrimaryKey(Table table) {
        this();
        this.table = table;
    }

    //**************************************************************************
    // ModelObject implementation
    //**************************************************************************

    public String getQualifiedName() {
        return MessageFormat.format("{0}#{1}",
                table.getQualifiedName(), primaryKeyName);
    }

    public void afterUnmarshal(Unmarshaller u, Object parent) {
        table = (Table) parent;
    }

    public void reset() {
        columns.clear();
        valid = true;
    }

    public void init(Model model) {
        assert table != null;

// Liquibase on MySQL returns null primaryKey name if the name is "PRIMARY"
//        assert primaryKeyName != null;

        if (primaryKeyColumns.isEmpty()) {
            throw new Error(MessageFormat.format(
                    "Primary key {0} has no columns",
                    getQualifiedName()));
        }

    }

    public void link(Model model) {
        for (PrimaryKeyColumn pkc : primaryKeyColumns) {
            Column column = pkc.getActualColumn();
            if (column == null) {
                valid = false;
                logger.error("Invalid primary key column: {}-{}",
                        getQualifiedName(), pkc.getColumnName());
            } else {
                columns.add(column);
            }
        }

        if (columns.isEmpty()) {
            logger.warn("Primary key '{}' has no columns", this);
        }
    }

    public void visitChildren(ModelObjectVisitor visitor) {
        for (PrimaryKeyColumn pkc : primaryKeyColumns) {
            visitor.visit(pkc);
        }
    }

    //**************************************************************************
    // Find methods
    //**************************************************************************

    public PrimaryKeyColumn findPrimaryKeyColumnByNameIgnoreCase(String columnName) {
        for (PrimaryKeyColumn primaryKeyColumn : primaryKeyColumns) {
            if (primaryKeyColumn.getColumnName().equalsIgnoreCase(columnName)) {
                return primaryKeyColumn;
            }
        }
        return null;
    }

    public PrimaryKeyColumn findPrimaryKeyColumnByName(String columnName) {
        for (PrimaryKeyColumn primaryKeyColumn : primaryKeyColumns) {
            if (primaryKeyColumn.getColumnName().equals(columnName)) {
                return primaryKeyColumn;
            }
        }
        return null;
    }

    //**************************************************************************
    // Getters/setter
    //**************************************************************************

    public Table getTable() {
        return table;
    }

    public void setTable(Table table) {
        this.table = table;
    }

    public List getColumns() {
        return columns;
    }

    public String getDatabaseName() {
        return table.getTableName();
    }

    public String getSchemaName() {
        return table.getSchemaName();
    }

    public String getTableName() {
        return table.getTableName();
    }

    @Required
    @XmlAttribute(required = true)
    public String getPrimaryKeyName() {
        return primaryKeyName;
    }

    public void setPrimaryKeyName(String primaryKeyName) {
        this.primaryKeyName = primaryKeyName;
    }

    @XmlElement(name="column",type=PrimaryKeyColumn.class)
    public List getPrimaryKeyColumns() {
        return primaryKeyColumns;
    }

    public boolean isValid() {
        return valid;
    }

    //**************************************************************************
    // toString() override
    //**************************************************************************

    @Override
    public String toString() {
        return MessageFormat.format("primary key {0}", getQualifiedName());
    }
}