alfresco-community-repo/source/java/org/alfresco/util/schemacomp/model/PrimaryKey.java

/*
 * Copyright (C) 2005-2011 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco 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.
 *
 * Alfresco 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 Alfresco. If not, see <http://www.gnu.org/licenses/>.
 */
package org.alfresco.util.schemacomp.model;

import java.util.ArrayList;
import java.util.List;

import org.alfresco.util.schemacomp.DbObjectVisitor;
import org.alfresco.util.schemacomp.DbProperty;
import org.alfresco.util.schemacomp.DiffContext;
import org.alfresco.util.schemacomp.Result.Strength;

/**
 * Primary key on a table.
 * 
 * @author Matt Ward
 */
public class PrimaryKey extends AbstractDbObject
{
    private final List<String> columnNames = new ArrayList<String>();
    private final List<Integer> columnOrders = new ArrayList<Integer>();


    public PrimaryKey(String name)
    {
        super(null, name);
    }
    
    /**
     * Constructor
     * @param table the parent table
     * @param name
     * @param columnNames
     */
    public PrimaryKey(Table table, String name, List<String> columnNames, List<Integer> columnOrders)
    {
        super(table, name);
        this.columnNames.addAll(columnNames);
        this.columnOrders.addAll(columnOrders);
        checkColumnOrders();
    }

    /**
     * Ensure that if columnOrders are being used, there are
     * as many of them as there are column names.
     */
    private void checkColumnOrders()
    {
        if (columnOrders.size() > 0 && columnOrders.size() != columnNames.size())
        {
            throw new IllegalArgumentException("columnOrders size does not match columnNames");
        }
    }

    /**
     * @return the columnNames
     */
    public List<String> getColumnNames()
    {
        return this.columnNames;
    }

    /**
     * @param columnNames the columnNames to set
     */
    public void setColumnNames(List<String> columnNames)
    {
        this.columnNames.clear();
        this.columnNames.addAll(columnNames);
    }
    
    /**
     * @return the columnOrders
     */
    public List<Integer> getColumnOrders()
    {
        return this.columnOrders;
    }
    
    /**
     * @param columnOrders the columnOrders to set
     */
    public void setColumnOrders(List<Integer> columnOrders)
    {
        this.columnOrders.clear();
        this.columnOrders.addAll(columnOrders);
    }

    @Override
    public int hashCode()
    {
        final int prime = 31;
        int result = super.hashCode();
        result = prime * result + ((this.columnNames == null) ? 0 : this.columnNames.hashCode());
        result = prime * result + ((this.columnOrders == null) ? 0 : this.columnOrders.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj)
    {
        if (this == obj) return true;
        if (!super.equals(obj)) return false;
        if (getClass() != obj.getClass()) return false;
        PrimaryKey other = (PrimaryKey) obj;
        if (this.columnNames == null)
        {
            if (other.columnNames != null) return false;
        }
        else if (!this.columnNames.equals(other.columnNames)) return false;
        if (this.columnOrders == null)
        {
            if (other.columnOrders != null) return false;
        }
        else if (!this.columnOrders.equals(other.columnOrders)) return false;
        return true;
    }

    @Override
    protected void doDiff(DbObject right, DiffContext ctx, Strength strength)
    {
        checkColumnOrders();
        PrimaryKey rightPK = (PrimaryKey) right;        
        comparisonUtils.compareSimpleCollections(
                    new DbProperty(this, "columnNames"),
                    new DbProperty(rightPK, "columnNames"),
                    ctx,
                    strength);
        comparisonUtils.compareSimpleCollections(
                    new DbProperty(this, "columnOrders"),
                    new DbProperty(rightPK, "columnOrders"),
                    ctx,
                    strength);
    }

    @Override
    public void accept(DbObjectVisitor visitor)
    {
        checkColumnOrders();
        visitor.visit(this);
    }
    
    @Override
    public String getTypeName()
    {
        return "primary key";
    }
}