Matt Ward 9b4cd0ab0e ALF-10771: DiffContext is now passed around to provide the DB Dialect.
Instead of the Differences being passed around on their own, the DiffContext is able to provide more information -- at present just the Dialect. The dialect can be used to change the way database objects are validated or differenced.





git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@31466 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2011-10-25 16:03:31 +00:00

64 lines
2.6 KiB
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 org.alfresco.util.schemacomp.DiffContext;
import org.alfresco.util.schemacomp.Differences;
import org.alfresco.util.schemacomp.Result.Strength;
/**
* All database objects to be modelled for schema comparisons must implement this interface, examples
* of which include: schemas, tables, indexes, primary keys, foreign keys, sequences and columns.
*
* @author Matt Ward
*/
public interface DbObject
{
/**
* Are the two <code>DbObject</code>s logically the same? For example two Index objects may have
* different names, but are the same index as they both index the same columns for the same table.
* <p>
* If two objects a and b have the same logical identity, it does not mean that <code>a.equals(b) == true</code>.
* The two objects may well have differences and will be flagged as such by the schema comparison tool. When
* <code>a.sameAs(b) == true</code> it makes it easier to show the differences as related, i.e. a and b are
* different rather than, a is only in the 'left' tree and b is only in the 'right' tree.
*
* @param other
* @return
*/
boolean sameAs(DbObject other);
/**
* All items can be asked for their name, but it may be null.
*
* @return Name if available, null otherwise.
*/
String getName();
/**
* Generate a report of differences between this object ('left') and another object ('right').
* Differences between the left and right objects under inspection are captured in the {@link Differences}
* object passed in to this method.
*
* @param right The object to compare against.
* @param ctx The DiffContext
*/
void diff(DbObject right, DiffContext ctx, Strength strength);
}