/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.persister.walking.spi;

import java.util.Arrays;

import org.hibernate.internal.util.StringHelper;

Used to uniquely identify a foreign key, so that we don't join it more than once creating circularities. Note that the table+columns refers to the association owner. These are used to help detect bi-directional associations since the Hibernate runtime metamodel (persisters) do not inherently know this information. For example, consider the Order -> Customer and Customer -> Order(s) bi-directional association; both would be mapped to the ORDER_TABLE.CUST_ID column. That is the purpose of this struct. 

Bit of a misnomer to call this an association attribute.  But this follows the legacy use of AssociationKey
from old JoinWalkers to denote circular join detection
Author:
Steve Ebersole, Gail Badner, Gavin King/**
 * Used to uniquely identify a foreign key, so that we don't join it more than once creating circularities.  Note
 * that the table+columns refers to the association owner.  These are used to help detect bi-directional associations
 * since the Hibernate runtime metamodel (persisters) do not inherently know this information.  For example, consider
 * the Order -> Customer and Customer -> Order(s) bi-directional association; both would be mapped to the
 * {@code ORDER_TABLE.CUST_ID} column.  That is the purpose of this struct.
 * <p/>
 * Bit of a misnomer to call this an association attribute.  But this follows the legacy use of AssociationKey
 * from old JoinWalkers to denote circular join detection
 *
 * @author Steve Ebersole
 * @author Gail Badner
 * @author Gavin King
 */
public class AssociationKey {
	private final String table;
	private final String[] columns;

	
Create the AssociationKey.
Params:
table – The table part of the association key
columns – The columns that define the association key/**
	 * Create the AssociationKey.
	 *
	 * @param table The table part of the association key
	 * @param columns The columns that define the association key
	 */
	public AssociationKey(String table, String[] columns) {
		this.table = table;
		this.columns = columns;
	}

	@Override
	public boolean equals(Object o) {
		if ( this == o ) {
			return true;
		}
		if ( o == null || getClass() != o.getClass() ) {
			return false;
		}

		final AssociationKey that = (AssociationKey) o;
		return table.equals( that.table ) && Arrays.equals( columns, that.columns );

	}

	@Override
	public int hashCode() {
		return table.hashCode();
	}

	private String str;

	@Override
	public String toString() {
		if ( str == null ) {
			str = "AssociationKey(table=" + table + ", columns={" + StringHelper.join( ",", columns ) + "})";
		}
		return str;
	}
}