| /******************************************************************************* |
| * Copyright (c) 2007, 2008 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; |
| |
| /** |
| * |
| * |
| * 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. |
| */ |
| public interface JoinTable extends Table |
| { |
| |
| RelationshipMapping getParent(); |
| |
| // **************** join columns ************************************** |
| |
| /** |
| * Return a list iterator of the join columns whether specified or default. |
| * This will not be null. |
| */ |
| <T extends JoinColumn> ListIterator<T> joinColumns(); |
| |
| /** |
| * Return the number of join columns, both specified and default. |
| */ |
| int joinColumnsSize(); |
| |
| /** |
| * Return a list iterator of the specified join columns. |
| * This will not be null. |
| */ |
| <T extends JoinColumn> ListIterator<T> specifiedJoinColumns(); |
| String SPECIFIED_JOIN_COLUMNS_LIST = "specifiedJoinColumnsList"; |
| |
| /** |
| * 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"; |
| |
| /** |
| * Add a specified join column to the join table return the object |
| * representing it. |
| */ |
| JoinColumn addSpecifiedJoinColumn(int index); |
| |
| /** |
| * Remove the specified join column from the join table. |
| */ |
| void removeSpecifiedJoinColumn(int index); |
| |
| /** |
| * Remove the specified join column at the index from the join table. |
| */ |
| void removeSpecifiedJoinColumn(JoinColumn joinColumn); |
| |
| /** |
| * Move the specified join column from the source index to the target index. |
| */ |
| void moveSpecifiedJoinColumn(int targetIndex, int sourceIndex); |
| |
| boolean containsSpecifiedJoinColumns(); |
| |
| |
| // **************** inverse join columns ************************************** |
| |
| /** |
| * Return a list iterator of the inverse join columns whether specified or default. |
| * This will not be null. |
| */ |
| <T extends JoinColumn> ListIterator<T> inverseJoinColumns(); |
| |
| /** |
| * Return the number of inverse join columns, both specified and default. |
| */ |
| int inverseJoinColumnsSize(); |
| |
| /** |
| * Return a list iterator of the specified inverse join columns. |
| * This will not be null. |
| */ |
| <T extends JoinColumn> ListIterator<T> specifiedInverseJoinColumns(); |
| String SPECIFIED_INVERSE_JOIN_COLUMNS_LIST = "specifiedInverseJoinColumnsList"; |
| |
| /** |
| * Return the number of specified inverse join columns. |
| */ |
| int specifiedInverseJoinColumnsSize(); |
| |
| /** |
| * Return the default inverse join column or null. A default inverse join column |
| * only exists if there are no specified inverse join columns. |
| */ |
| JoinColumn getDefaultInverseJoinColumn(); |
| String DEFAULT_INVERSE_JOIN_COLUMN = "defaultInverseJoinColumn"; |
| |
| /** |
| * Add a specified inverse join column to the join table return the object |
| * representing it. |
| */ |
| JoinColumn addSpecifiedInverseJoinColumn(int index); |
| |
| /** |
| * Remove the specified inverse join column from the join table. |
| */ |
| void removeSpecifiedInverseJoinColumn(int index); |
| |
| /** |
| * Remove the specified inverse join column at the index from the join table. |
| */ |
| void removeSpecifiedInverseJoinColumn(JoinColumn joinColumn); |
| |
| |
| /** |
| * Move the specified inverse join column from the source index to the target index. |
| */ |
| void moveSpecifiedInverseJoinColumn(int targetIndex, int sourceIndex); |
| |
| boolean containsSpecifiedInverseJoinColumns(); |
| |
| } |