/*
 * 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;



/**
 * Result of a comparison between two database objects.
 * 
 * @author Matt Ward
 */
public final class Difference extends Result
{
    /** Specifies the type of differences */
    public enum Where { ONLY_IN_LEFT, ONLY_IN_RIGHT, IN_BOTH_NO_DIFFERENCE, IN_BOTH_BUT_DIFFERENCE };
    private final Where where;
    private final DbProperty left;
    private final DbProperty right;
    
    
    public Difference(Where where, DbProperty left, DbProperty right)
    {
        this(where, left, right, null);
    }
    
    public Difference(Where where, DbProperty left, DbProperty right, Strength strength)
    {
        super(null);
        this.where = where;
        this.left = left;
        this.right = right;
    }

    /**
     * @return the where
     */
    public Where getWhere()
    {
        return this.where;
    }

    /**
     * @return the left
     */
    public DbProperty getLeft()
    {
        return this.left;
    }

    /**
     * @return the right
     */
    public DbProperty getRight()
    {
        return this.right;
    }

    
    @Override
    public String describe()
    {
        StringBuffer sb = new StringBuffer();
        sb.append("Difference: ")
            .append(getWhere());
        
        sb.append(" reference path:");
        if (getLeft() != null)
        {
            sb.append(getLeft().getPath());
            sb.append(" (value: ")
                .append(getLeft().getPropertyValue())
                .append(")");
        }
        else
        {
            sb.append("null");
        }
        
        sb.append(" target path:");
        if (getRight() != null)
        {
            sb.append(getRight().getPath());
            sb.append(" (value: ")
            .append(getRight().getPropertyValue())
            .append(")");
        }
        else
        {
            sb.append("null");
        }
        
        return sb.toString();
    }

    @Override
    public String toString()
    {
        return "Difference [where=" + this.where + ", left=" + this.left + ", right=" + this.right
                    + ", strength=" + this.strength + "]";
    }
}