blob: 835d319d357676888a3b2723a28af1fe48f8d088 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2007, 2011 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.jpa.core.internal.jpa1.context.java;
import java.util.List;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jpt.common.core.utility.TextRange;
import org.eclipse.jpt.common.utility.Filter;
import org.eclipse.jpt.common.utility.internal.iterables.EmptyListIterable;
import org.eclipse.jpt.common.utility.internal.iterables.ListIterable;
import org.eclipse.jpt.common.utility.internal.iterables.SingleElementListIterable;
import org.eclipse.jpt.jpa.core.context.PrimaryKeyJoinColumn;
import org.eclipse.jpt.jpa.core.context.ReadOnlyBaseJoinColumn;
import org.eclipse.jpt.jpa.core.context.ReadOnlyNamedColumn;
import org.eclipse.jpt.jpa.core.context.java.JavaEntity;
import org.eclipse.jpt.jpa.core.context.java.JavaPrimaryKeyJoinColumn;
import org.eclipse.jpt.jpa.core.context.java.JavaReadOnlyBaseJoinColumn;
import org.eclipse.jpt.jpa.core.context.java.JavaSecondaryTable;
import org.eclipse.jpt.jpa.core.internal.context.BaseJoinColumnTextRangeResolver;
import org.eclipse.jpt.jpa.core.internal.context.JptValidator;
import org.eclipse.jpt.jpa.core.internal.context.NamedColumnTextRangeResolver;
import org.eclipse.jpt.jpa.core.internal.context.java.AbstractJavaTable;
import org.eclipse.jpt.jpa.core.internal.jpa1.context.SecondaryTablePrimaryKeyJoinColumnValidator;
import org.eclipse.jpt.jpa.core.internal.resource.java.NullPrimaryKeyJoinColumnAnnotation;
import org.eclipse.jpt.jpa.core.resource.java.PrimaryKeyJoinColumnAnnotation;
import org.eclipse.jpt.jpa.core.resource.java.SecondaryTableAnnotation;
import org.eclipse.jpt.jpa.db.Table;
import org.eclipse.wst.validation.internal.provisional.core.IMessage;
import org.eclipse.wst.validation.internal.provisional.core.IReporter;
/**
* Java secondary table
*/
public class GenericJavaSecondaryTable
extends AbstractJavaTable<SecondaryTableAnnotation>
implements JavaSecondaryTable
{
/** @see AbstractJavaTable#AbstractJavaTable(org.eclipse.jpt.jpa.core.context.java.JavaJpaContextNode, org.eclipse.jpt.jpa.core.context.Table.Owner, org.eclipse.jpt.jpa.core.resource.java.BaseTableAnnotation) */
protected /* final */ SecondaryTableAnnotation tableAnnotation;
protected final ContextListContainer<JavaPrimaryKeyJoinColumn, PrimaryKeyJoinColumnAnnotation> specifiedPrimaryKeyJoinColumnContainer;
protected final JavaReadOnlyBaseJoinColumn.Owner primaryKeyJoinColumnOwner;
protected JavaPrimaryKeyJoinColumn defaultPrimaryKeyJoinColumn;
public GenericJavaSecondaryTable(JavaEntity parent, Owner owner, SecondaryTableAnnotation tableAnnotation) {
super(parent, owner, tableAnnotation);
this.primaryKeyJoinColumnOwner = this.buildPrimaryKeyJoinColumnOwner();
this.specifiedPrimaryKeyJoinColumnContainer = this.buildSpecifiedPrimaryKeyJoinColumnContainer();
}
// ********** synchronize/update **********
@Override
public void synchronizeWithResourceModel() {
super.synchronizeWithResourceModel();
this.syncSpecifiedPrimaryKeyJoinColumns();
}
@Override
public void update() {
super.update();
this.updateNodes(this.getSpecifiedPrimaryKeyJoinColumns());
this.updateDefaultPrimaryKeyJoinColumn();
}
// ********** table annotation **********
@Override
public SecondaryTableAnnotation getTableAnnotation() {
return this.tableAnnotation;
}
/**
* @see AbstractJavaTable
*/
@Override
protected void setTableAnnotation(SecondaryTableAnnotation tableAnnotation) {
this.tableAnnotation = tableAnnotation;
}
@Override
protected void removeTableAnnotation() {
// even though its name is required, we don't remove a secondary table'
// annotation when it is empty since it is part of a list and it's not
// obvious whether this would be very user-helpful...
}
protected String getAnnotationName() {
return SecondaryTableAnnotation.ANNOTATION_NAME;
}
// ********** primary key join columns **********
public ListIterable<JavaPrimaryKeyJoinColumn> getPrimaryKeyJoinColumns() {
return this.hasSpecifiedPrimaryKeyJoinColumns() ? this.getSpecifiedPrimaryKeyJoinColumns() : this.getDefaultPrimaryKeyJoinColumns();
}
public int getPrimaryKeyJoinColumnsSize() {
return this.hasSpecifiedPrimaryKeyJoinColumns() ? this.getSpecifiedPrimaryKeyJoinColumnsSize() : this.getDefaultPrimaryKeyJoinColumnsSize();
}
// ********** specified primary key join columns **********
public ListIterable<JavaPrimaryKeyJoinColumn> getSpecifiedPrimaryKeyJoinColumns() {
return this.specifiedPrimaryKeyJoinColumnContainer.getContextElements();
}
public int getSpecifiedPrimaryKeyJoinColumnsSize() {
return this.specifiedPrimaryKeyJoinColumnContainer.getContextElementsSize();
}
protected boolean hasSpecifiedPrimaryKeyJoinColumns() {
return this.getSpecifiedPrimaryKeyJoinColumnsSize() != 0;
}
public JavaPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn() {
return this.addSpecifiedPrimaryKeyJoinColumn(this.getSpecifiedPrimaryKeyJoinColumnsSize());
}
public JavaPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index) {
PrimaryKeyJoinColumnAnnotation annotation = this.tableAnnotation.addPkJoinColumn(index);
return this.specifiedPrimaryKeyJoinColumnContainer.addContextElement(index, annotation);
}
public void removeSpecifiedPrimaryKeyJoinColumn(PrimaryKeyJoinColumn joinColumn) {
this.removeSpecifiedPrimaryKeyJoinColumn(this.specifiedPrimaryKeyJoinColumnContainer.indexOfContextElement((JavaPrimaryKeyJoinColumn) joinColumn));
}
public void removeSpecifiedPrimaryKeyJoinColumn(int index) {
this.tableAnnotation.removePkJoinColumn(index);
this.removeTableAnnotationIfUnset();
this.specifiedPrimaryKeyJoinColumnContainer.removeContextElement(index);
}
public void moveSpecifiedPrimaryKeyJoinColumn(int targetIndex, int sourceIndex) {
this.tableAnnotation.movePkJoinColumn(targetIndex, sourceIndex);
this.specifiedPrimaryKeyJoinColumnContainer.moveContextElement(targetIndex, sourceIndex);
}
protected void syncSpecifiedPrimaryKeyJoinColumns() {
this.specifiedPrimaryKeyJoinColumnContainer.synchronizeWithResourceModel();
}
protected ListIterable<PrimaryKeyJoinColumnAnnotation> getPrimaryKeyJoinColumnAnnotations() {
return this.tableAnnotation.getPkJoinColumns();
}
/**
* specified primary key join column container
*/
protected class SpecifiedPrimaryKeyJoinColumnContainer
extends ContextListContainer<JavaPrimaryKeyJoinColumn, PrimaryKeyJoinColumnAnnotation>
{
@Override
protected String getContextElementsPropertyName() {
return SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST;
}
@Override
protected JavaPrimaryKeyJoinColumn buildContextElement(PrimaryKeyJoinColumnAnnotation resourceElement) {
return GenericJavaSecondaryTable.this.buildPrimaryKeyJoinColumn(resourceElement);
}
@Override
protected ListIterable<PrimaryKeyJoinColumnAnnotation> getResourceElements() {
return GenericJavaSecondaryTable.this.getPrimaryKeyJoinColumnAnnotations();
}
@Override
protected PrimaryKeyJoinColumnAnnotation getResourceElement(JavaPrimaryKeyJoinColumn contextElement) {
return contextElement.getColumnAnnotation();
}
}
protected JavaReadOnlyBaseJoinColumn.Owner buildPrimaryKeyJoinColumnOwner() {
return new PrimaryKeyJoinColumnOwner();
}
protected ContextListContainer<JavaPrimaryKeyJoinColumn, PrimaryKeyJoinColumnAnnotation> buildSpecifiedPrimaryKeyJoinColumnContainer() {
SpecifiedPrimaryKeyJoinColumnContainer container = new SpecifiedPrimaryKeyJoinColumnContainer();
container.initialize();
return container;
}
// ********** default primary key join column **********
public JavaPrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn() {
return this.defaultPrimaryKeyJoinColumn;
}
protected void setDefaultPrimaryKeyJoinColumn(JavaPrimaryKeyJoinColumn joinColumn) {
JavaPrimaryKeyJoinColumn old = this.defaultPrimaryKeyJoinColumn;
this.defaultPrimaryKeyJoinColumn = joinColumn;
this.firePropertyChanged(DEFAULT_PRIMARY_KEY_JOIN_COLUMN, old, joinColumn);
}
protected ListIterable<JavaPrimaryKeyJoinColumn> getDefaultPrimaryKeyJoinColumns() {
return (this.defaultPrimaryKeyJoinColumn != null) ?
new SingleElementListIterable<JavaPrimaryKeyJoinColumn>(this.defaultPrimaryKeyJoinColumn) :
EmptyListIterable.<JavaPrimaryKeyJoinColumn>instance();
}
protected int getDefaultPrimaryKeyJoinColumnsSize() {
return (this.defaultPrimaryKeyJoinColumn == null) ? 0 : 1;
}
protected void updateDefaultPrimaryKeyJoinColumn() {
if (this.buildsDefaultPrimaryKeyJoinColumn()) {
if (this.defaultPrimaryKeyJoinColumn == null) {
this.setDefaultPrimaryKeyJoinColumn(this.buildPrimaryKeyJoinColumn(new NullPrimaryKeyJoinColumnAnnotation(this.tableAnnotation)));
} else {
this.defaultPrimaryKeyJoinColumn.update();
}
} else {
this.setDefaultPrimaryKeyJoinColumn(null);
}
}
protected boolean buildsDefaultPrimaryKeyJoinColumn() {
return ! this.hasSpecifiedPrimaryKeyJoinColumns();
}
// ********** misc **********
@Override
public JavaEntity getParent() {
return (JavaEntity) super.getParent();
}
protected JavaEntity getEntity() {
return this.getParent();
}
public boolean isVirtual() {
return false;
}
protected JavaPrimaryKeyJoinColumn buildPrimaryKeyJoinColumn(PrimaryKeyJoinColumnAnnotation pkJoinColumnAnnotation) {
return this.getJpaFactory().buildJavaPrimaryKeyJoinColumn(this, this.primaryKeyJoinColumnOwner, pkJoinColumnAnnotation);
}
// ********** defaults **********
/**
* a secondary table doesn't have a default name
*/
@Override
protected String buildDefaultName() {
return null;
}
@Override
protected String buildDefaultSchema() {
return this.getContextDefaultSchema();
}
@Override
protected String buildDefaultCatalog() {
return this.getContextDefaultCatalog();
}
// ********** code completion **********
@Override
public Iterable<String> getJavaCompletionProposals(int pos, Filter<String> filter, CompilationUnit astRoot) {
Iterable<String> result = super.getJavaCompletionProposals(pos, filter, astRoot);
if (result != null) {
return result;
}
for (JavaPrimaryKeyJoinColumn column : this.getPrimaryKeyJoinColumns()) {
result = column.getJavaCompletionProposals(pos, filter, astRoot);
if (result != null) {
return result;
}
}
return null;
}
// ********** validation **********
@Override
public void validate(List<IMessage> messages, IReporter reporter, CompilationUnit astRoot) {
boolean continueValidating = this.buildTableValidator(astRoot).validate(messages, reporter);
//join column validation will handle the check for whether to validate against the database
//some validation messages are not database specific. If the database validation for the
//table fails we will stop there and not validate the join columns at all
if (continueValidating) {
for (JavaPrimaryKeyJoinColumn pkJoinColumn : this.getPrimaryKeyJoinColumns()) {
pkJoinColumn.validate(messages, reporter, astRoot);
}
}
}
public boolean validatesAgainstDatabase() {
return this.connectionProfileIsActive();
}
// ********** primary key join column owner adapter **********
protected class PrimaryKeyJoinColumnOwner
implements JavaReadOnlyBaseJoinColumn.Owner
{
protected JavaEntity getEntity() {
return GenericJavaSecondaryTable.this.getEntity();
}
public String getDefaultTableName() {
return GenericJavaSecondaryTable.this.getName();
}
public Table resolveDbTable(String tableName) {
return GenericJavaSecondaryTable.this.getDbTable();
}
public Table getReferencedColumnDbTable() {
return this.getEntity().getPrimaryDbTable();
}
public int getJoinColumnsSize() {
return GenericJavaSecondaryTable.this.getPrimaryKeyJoinColumnsSize();
}
public boolean joinColumnIsDefault(ReadOnlyBaseJoinColumn joinColumn) {
return GenericJavaSecondaryTable.this.defaultPrimaryKeyJoinColumn == joinColumn;
}
public String getDefaultColumnName(ReadOnlyNamedColumn column) {
if (this.getJoinColumnsSize() != 1) {
return null;
}
return this.getEntity().getPrimaryKeyColumnName();
}
public TextRange getValidationTextRange(CompilationUnit astRoot) {
return GenericJavaSecondaryTable.this.getValidationTextRange(astRoot);
}
public JptValidator buildColumnValidator(ReadOnlyNamedColumn column, NamedColumnTextRangeResolver textRangeResolver) {
return new SecondaryTablePrimaryKeyJoinColumnValidator(GenericJavaSecondaryTable.this, (ReadOnlyBaseJoinColumn) column, this, (BaseJoinColumnTextRangeResolver) textRangeResolver);
}
}
}