| /******************************************************************************* |
| * Copyright (c) 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.eclipselink.core.internal.context.orm; |
| |
| import java.util.List; |
| import org.eclipse.jdt.core.IJavaProject; |
| import org.eclipse.jdt.core.IPackageFragment; |
| import org.eclipse.jdt.core.IType; |
| import org.eclipse.jpt.common.core.internal.utility.JDTTools; |
| import org.eclipse.jpt.common.core.resource.java.JavaResourceAbstractType; |
| import org.eclipse.jpt.common.core.utility.TextRange; |
| import org.eclipse.jpt.common.utility.internal.StringTools; |
| import org.eclipse.jpt.common.utility.internal.iterables.EmptyIterable; |
| import org.eclipse.jpt.common.utility.internal.iterables.SingleElementIterable; |
| import org.eclipse.jpt.jpa.core.context.XmlContextNode; |
| import org.eclipse.jpt.jpa.eclipselink.core.context.EclipseLinkConverterClassConverter; |
| import org.eclipse.jpt.jpa.eclipselink.core.internal.DefaultEclipseLinkJpaValidationMessages; |
| import org.eclipse.jpt.jpa.eclipselink.core.internal.EclipseLinkJpaValidationMessages; |
| import org.eclipse.jpt.jpa.eclipselink.core.resource.orm.XmlNamedConverter; |
| import org.eclipse.text.edits.ReplaceEdit; |
| import org.eclipse.wst.validation.internal.provisional.core.IMessage; |
| import org.eclipse.wst.validation.internal.provisional.core.IReporter; |
| |
| public abstract class OrmEclipseLinkConverterClassConverter<X extends XmlNamedConverter> |
| extends OrmEclipseLinkConverter<X> |
| implements EclipseLinkConverterClassConverter |
| { |
| private String converterClass; |
| |
| protected JavaResourceAbstractType converterResourceType; |
| |
| |
| public OrmEclipseLinkConverterClassConverter(XmlContextNode parent, X xmlConverter, String converterClass) { |
| super(parent, xmlConverter); |
| this.converterClass = converterClass; |
| } |
| |
| |
| // ********** synchronize/update ********** |
| |
| @Override |
| public void synchronizeWithResourceModel() { |
| super.synchronizeWithResourceModel(); |
| this.setConverterClass_(this.getXmlConverterClass()); |
| } |
| |
| |
| // ********** converter class ********** |
| |
| public String getConverterClass() { |
| return this.converterClass; |
| } |
| |
| public void setConverterClass(String converterClass) { |
| this.setConverterClass_(converterClass); |
| this.setXmlConverterClass(converterClass); |
| } |
| |
| protected void setConverterClass_(String newConverterClass) { |
| String oldConverterClass = this.converterClass; |
| this.converterClass = newConverterClass; |
| this.firePropertyChanged(CONVERTER_CLASS_PROPERTY, oldConverterClass, newConverterClass); |
| } |
| |
| protected JavaResourceAbstractType getConverterJavaResourceType() { |
| return this.getMappingFileRoot().resolveJavaResourceType(this.converterClass); |
| } |
| |
| protected abstract String getXmlConverterClass(); |
| |
| protected abstract void setXmlConverterClass(String converterClass); |
| |
| |
| // ********** resource interaction ********** |
| |
| protected void updateConverterResourceType() { |
| this.converterResourceType = this.getConverterJavaResourceType(); |
| } |
| |
| |
| // ********** validation ********** |
| |
| @Override |
| public void validate(List<IMessage> messages, IReporter reporter) { |
| super.validate(messages, reporter); |
| this.validateConverterClass(messages); |
| } |
| |
| protected void validateConverterClass(List<IMessage> messages) { |
| if (StringTools.stringIsEmpty(this.converterClass)) { |
| messages.add( |
| DefaultEclipseLinkJpaValidationMessages.buildMessage( |
| IMessage.HIGH_SEVERITY, |
| EclipseLinkJpaValidationMessages.CONVERTER_CLASS_DEFINED, |
| this, |
| this.getConverterClassTextRange() |
| ) |
| ); |
| return; |
| } |
| |
| if ( ! this.converterClassExists()) { |
| messages.add( |
| DefaultEclipseLinkJpaValidationMessages.buildMessage( |
| IMessage.HIGH_SEVERITY, |
| EclipseLinkJpaValidationMessages.CONVERTER_CLASS_EXISTS, |
| new String[] {this.converterClass}, |
| this, |
| this.getConverterClassTextRange() |
| ) |
| ); |
| return; |
| } |
| |
| if ( ! this.converterClassImplementsInterface(this.getEclipseLinkConverterInterface())) { |
| messages.add( |
| DefaultEclipseLinkJpaValidationMessages.buildMessage( |
| IMessage.HIGH_SEVERITY, |
| this.getEclipseLinkConverterInterfaceErrorMessage(), |
| new String[] {this.converterClass}, |
| this, |
| this.getConverterClassTextRange() |
| ) |
| ); |
| } |
| } |
| |
| /** |
| * Return the name of the EclipseLink interface the converter class must |
| * implement. |
| */ |
| protected abstract String getEclipseLinkConverterInterface(); |
| |
| protected abstract String getEclipseLinkConverterInterfaceErrorMessage(); |
| |
| protected boolean converterClassExists() { |
| return this.typeExists(this.converterClass) || |
| this.typeExists(this.getAlternateConverterClass()); |
| } |
| |
| /** |
| * Add <code>null</code> check. |
| */ |
| protected boolean typeExists(String typeName) { |
| return (typeName != null) && |
| (JDTTools.findType(this.getJavaProject(), typeName) != null); |
| } |
| |
| /** |
| * Add <code>null</code> check. |
| */ |
| protected boolean typeImplementsInterface(String typeName, String interfaceName) { |
| return (typeName != null) && |
| JDTTools.typeIsSubType(this.getJavaProject(), typeName, interfaceName); |
| } |
| |
| protected boolean converterClassImplementsInterface(String interfaceName) { |
| return this.typeImplementsInterface(this.converterClass, interfaceName) || |
| this.typeImplementsInterface(this.getAlternateConverterClass(), interfaceName); |
| } |
| |
| /** |
| * If present, append the mapping file package to the converter class and |
| * return it. Return <code>null</code> if the mapping file package is not |
| * specified. |
| */ |
| protected String getAlternateConverterClass() { |
| String mappingFilePackage = this.getMappingFileRoot().getPackage(); |
| if (StringTools.stringIsEmpty(mappingFilePackage)) { |
| return null; |
| } |
| return mappingFilePackage + '.' + this.converterClass; |
| } |
| |
| protected TextRange getConverterClassTextRange() { |
| return this.getValidationTextRange(this.getXmlConverterClassTextRange()); |
| } |
| |
| protected abstract TextRange getXmlConverterClassTextRange(); |
| |
| protected IJavaProject getJavaProject() { |
| return this.getJpaProject().getJavaProject(); |
| } |
| |
| |
| // ********** refactoring ********** |
| |
| @Override |
| public Iterable<ReplaceEdit> createRenameTypeEdits(IType originalType, String newName) { |
| return this.isFor(originalType.getFullyQualifiedName('.')) ? |
| new SingleElementIterable<ReplaceEdit>(this.createRenameEdit(originalType, newName)) : |
| EmptyIterable.<ReplaceEdit>instance(); |
| } |
| |
| protected abstract ReplaceEdit createRenameEdit(IType originalType, String newName); |
| |
| @Override |
| public Iterable<ReplaceEdit> createMoveTypeEdits(IType originalType, IPackageFragment newPackage) { |
| return this.isFor(originalType.getFullyQualifiedName('.')) ? |
| new SingleElementIterable<ReplaceEdit>(this.createRenamePackageEdit(newPackage.getElementName())) : |
| EmptyIterable.<ReplaceEdit>instance(); |
| } |
| |
| protected abstract ReplaceEdit createRenamePackageEdit(String newName); |
| |
| @Override |
| public Iterable<ReplaceEdit> createRenamePackageEdits(IPackageFragment originalPackage, String newName) { |
| return this.isIn(originalPackage) ? |
| new SingleElementIterable<ReplaceEdit>(this.createRenamePackageEdit(newName)) : |
| EmptyIterable.<ReplaceEdit>instance(); |
| } |
| |
| protected boolean isFor(String typeName) { |
| JavaResourceAbstractType converterType = this.getConverterJavaResourceType(); |
| return (converterType != null) && converterType.getQualifiedName().equals(typeName); |
| } |
| |
| protected boolean isIn(IPackageFragment packageFragment) { |
| JavaResourceAbstractType converterType = this.getConverterJavaResourceType(); |
| return (converterType != null) && converterType.isIn(packageFragment); |
| } |
| } |