| /******************************************************************************* |
| * 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; |
| |
| import java.util.ListIterator; |
| |
| /** |
| * Common interface for JoinTable and CollectionTable |
| * |
| * 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.3 |
| */ |
| public interface ReferenceTable |
| extends Table |
| { |
| |
| PersistentAttribute getPersistentAttribute(); |
| |
| // ********** join columns ********** |
| |
| /** |
| * Return the join table's join columns, whether specified or default. |
| */ |
| <T extends JoinColumn> ListIterator<T> joinColumns(); |
| |
| /** |
| * Return the number of join columns, whether specified or default. |
| */ |
| int joinColumnsSize(); |
| |
| /** |
| * Convert the join table's default join column to a specified join column. |
| */ |
| void convertDefaultToSpecifiedJoinColumn(); |
| |
| /** |
| * Return the specified join columns. |
| */ |
| <T extends JoinColumn> ListIterator<T> specifiedJoinColumns(); |
| String SPECIFIED_JOIN_COLUMNS_LIST = "specifiedJoinColumns"; //$NON-NLS-1$ |
| |
| /** |
| * Return the number of specified join columns. |
| */ |
| int specifiedJoinColumnsSize(); |
| |
| /** |
| * Return the default join column or null. A default join column |
| * only exists if there are no specified join columns. |
| */ |
| JoinColumn getDefaultJoinColumn(); |
| String DEFAULT_JOIN_COLUMN = "defaultJoinColumn"; //$NON-NLS-1$ |
| |
| /** |
| * Add a specified join column to the join table. |
| * Return the newly-created join column. |
| */ |
| JoinColumn addSpecifiedJoinColumn(int index); |
| |
| /** |
| * Remove the join column at the specified index from the join table. |
| */ |
| void removeSpecifiedJoinColumn(int index); |
| |
| /** |
| * Remove the specified join column from the join table. |
| */ |
| void removeSpecifiedJoinColumn(JoinColumn joinColumn); |
| |
| /** |
| * Move a join column from the specified source index to the |
| * specified target index. |
| */ |
| void moveSpecifiedJoinColumn(int targetIndex, int sourceIndex); |
| |
| /** |
| * Return whether the join table has specified join columns. |
| */ |
| boolean hasSpecifiedJoinColumns(); |
| |
| /** |
| * Remove all the join table's join columns. |
| */ |
| void clearSpecifiedJoinColumns(); |
| |
| } |