blob: b0ec5212ff2cf4617aaf2a94e68bad8e2a9c7c6f [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2007, 2010 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0, which accompanies this distribution
* and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Contributors:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.core.context;
/**
* join column
*
* Provisional API: This interface is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*
* @version 2.3
* @since 2.0
*/
public interface JoinColumn
extends BaseColumn, BaseJoinColumn
{
/**
* interface allowing join columns to be used in multiple places
* (e.g. 1:1 mappings and join tables)
*/
interface Owner
extends BaseJoinColumn.Owner, BaseColumn.Owner
{
/**
* The target of the relationship will usually be the target entity.
* In the case of a target foreign key relationship the source and target
* are swapped.
*/
Entity getRelationshipTarget();
/**
* return the join column's attribute name
*/
String getAttributeName();
/**
* return the persistent attribute for this join column
*/
PersistentAttribute getPersistentAttribute();
}
}