| /******************************************************************************* |
| * Copyright (c) 2009, 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.core.internal.context.orm; |
| |
| import java.util.Iterator; |
| import java.util.List; |
| import org.eclipse.jpt.core.context.AttributeMapping; |
| import org.eclipse.jpt.core.context.Entity; |
| import org.eclipse.jpt.core.context.MappedByRelationshipStrategy; |
| import org.eclipse.jpt.core.context.PersistentAttribute; |
| import org.eclipse.jpt.core.context.RelationshipMapping; |
| import org.eclipse.jpt.core.context.orm.OrmMappedByRelationshipStrategy; |
| import org.eclipse.jpt.core.context.orm.OrmMappedByRelationship; |
| import org.eclipse.jpt.core.internal.validation.DefaultJpaValidationMessages; |
| import org.eclipse.jpt.core.internal.validation.JpaValidationDescriptionMessages; |
| import org.eclipse.jpt.core.internal.validation.JpaValidationMessages; |
| import org.eclipse.jpt.core.resource.orm.XmlMappedByMapping; |
| import org.eclipse.jpt.core.utility.TextRange; |
| import org.eclipse.jpt.db.Table; |
| import org.eclipse.jpt.utility.internal.ArrayTools; |
| import org.eclipse.jpt.utility.internal.Tools; |
| import org.eclipse.osgi.util.NLS; |
| import org.eclipse.wst.validation.internal.provisional.core.IMessage; |
| import org.eclipse.wst.validation.internal.provisional.core.IReporter; |
| |
| public class GenericOrmMappedByRelationshipStrategy |
| extends AbstractOrmXmlContextNode |
| implements OrmMappedByRelationshipStrategy |
| { |
| protected String mappedByAttribute; |
| |
| |
| public GenericOrmMappedByRelationshipStrategy(OrmMappedByRelationship parent) { |
| super(parent); |
| this.mappedByAttribute = this.getXmlMappedByMapping().getMappedBy(); |
| } |
| |
| |
| // ********** synchronize/update ********** |
| |
| @Override |
| public void synchronizeWithResourceModel() { |
| super.synchronizeWithResourceModel(); |
| this.setMappedByAttribute_(this.getXmlMappedByMapping().getMappedBy()); |
| } |
| |
| |
| // ********** mapped by attribute ********** |
| |
| public String getMappedByAttribute() { |
| return this.mappedByAttribute; |
| } |
| |
| public void setMappedByAttribute(String mappedByAttribute) { |
| this.setMappedByAttribute_(mappedByAttribute); |
| this.getXmlMappedByMapping().setMappedBy(mappedByAttribute); |
| } |
| |
| protected void setMappedByAttribute_(String mappedByAttribute) { |
| String old = this.mappedByAttribute; |
| this.mappedByAttribute = mappedByAttribute; |
| this.firePropertyChanged(MAPPED_BY_ATTRIBUTE_PROPERTY, old, mappedByAttribute); |
| } |
| |
| |
| // ********** misc ********** |
| |
| @Override |
| public OrmMappedByRelationship getParent() { |
| return (OrmMappedByRelationship) super.getParent(); |
| } |
| |
| public OrmMappedByRelationship getRelationship() { |
| return this.getParent(); |
| } |
| |
| protected XmlMappedByMapping getXmlMappedByMapping() { |
| return this.getRelationship().getXmlContainer(); |
| } |
| |
| public void initializeFrom(MappedByRelationshipStrategy oldStrategy) { |
| this.setMappedByAttribute(oldStrategy.getMappedByAttribute()); |
| } |
| |
| public String getTableName() { |
| RelationshipMapping owner = this.getRelationshipOwner(); |
| return (owner == null) ? null : owner.getRelationship().getPredominantJoiningStrategy().getTableName(); |
| } |
| |
| public Table resolveDbTable(String tableName) { |
| RelationshipMapping owner = this.getRelationshipOwner(); |
| return (owner == null) ? null : owner.getRelationship().getPredominantJoiningStrategy().resolveDbTable(tableName); |
| } |
| |
| public boolean tableNameIsInvalid(String tableName) { |
| RelationshipMapping owner = this.getRelationshipOwner(); |
| return (owner != null) && owner.getRelationship().getPredominantJoiningStrategy().tableNameIsInvalid(tableName); |
| } |
| |
| public String getColumnTableNotValidDescription() { |
| // this will not be called if getRelationshipOwner() returns null |
| return this.getRelationshipOwner().getRelationship().getPredominantJoiningStrategy().getColumnTableNotValidDescription(); |
| } |
| |
| protected RelationshipMapping getRelationshipOwner() { |
| return this.getRelationshipMapping().getRelationshipOwner(); |
| } |
| |
| public boolean isOverridable() { |
| return false; |
| } |
| |
| protected RelationshipMapping getRelationshipMapping() { |
| return this.getRelationship().getMapping(); |
| } |
| |
| public boolean relationshipIsOwnedBy(RelationshipMapping otherMapping) { |
| String thisEntityName = this.getEntityName(); |
| Entity otherEntity = otherMapping.getResolvedTargetEntity(); |
| String otherEntityName = (otherEntity == null) ? null : otherEntity.getName(); |
| return Tools.valuesAreEqual(thisEntityName, otherEntityName) && |
| Tools.valuesAreEqual(this.mappedByAttribute, otherMapping.getName()); |
| } |
| |
| protected String getEntityName() { |
| Entity entity = this.getRelationship().getEntity(); |
| return (entity == null) ? null : entity.getName(); |
| } |
| |
| public void addStrategy() { |
| if (this.mappedByAttribute == null) { |
| this.setMappedByAttribute(""); //$NON-NLS-1$ |
| } |
| } |
| |
| public void removeStrategy() { |
| if (this.mappedByAttribute != null) { |
| this.setMappedByAttribute(null); |
| } |
| } |
| |
| public Iterator<String> candidateMappedByAttributeNames() { |
| return this.getRelationshipMapping().allTargetEntityAttributeNames(); |
| } |
| |
| |
| // ********** validation ********** |
| |
| public TextRange getValidationTextRange() { |
| TextRange mappedByTextRange = this.getXmlMappedByMapping().getMappedByTextRange(); |
| return (mappedByTextRange != null) ? mappedByTextRange : this.getRelationship().getValidationTextRange(); |
| } |
| |
| @Override |
| public void validate(List<IMessage> messages, IReporter reporter) { |
| super.validate(messages, reporter); |
| |
| if (this.mappedByAttribute == null) { |
| return; |
| } |
| |
| Entity targetEntity = this.getRelationshipMapping().getResolvedTargetEntity(); |
| if (targetEntity == null) { |
| return; // null target entity is validated elsewhere |
| } |
| |
| AttributeMapping mappedByMapping = targetEntity.resolveAttributeMapping(this.mappedByAttribute); |
| |
| if (mappedByMapping == null) { |
| messages.add( |
| this.buildMessage( |
| JpaValidationMessages.MAPPING_UNRESOLVED_MAPPED_BY, |
| new String[] {this.mappedByAttribute} |
| ) |
| ); |
| return; |
| } |
| |
| if ( ! this.getRelationship().mayBeMappedBy(mappedByMapping)) { |
| messages.add( |
| this.buildMessage( |
| JpaValidationMessages.MAPPING_INVALID_MAPPED_BY, |
| new String[] {this.mappedByAttribute} |
| ) |
| ); |
| return; |
| } |
| |
| // if mappedByMapping is not a relationship owner, then it should have |
| // been flagged in above rule (mappedByIsValid) |
| if ( ! ((RelationshipMapping) mappedByMapping).isRelationshipOwner()) { |
| messages.add( |
| this.buildMessage( |
| JpaValidationMessages.MAPPING_MAPPED_BY_ON_BOTH_SIDES, |
| new String[] {this.mappedByAttribute} |
| ) |
| ); |
| } |
| } |
| |
| protected IMessage buildMessage(String msgID, String[] parms) { |
| PersistentAttribute attribute = this.getRelationshipMapping().getPersistentAttribute(); |
| String attributeDescription = attribute.isVirtual() ? |
| JpaValidationDescriptionMessages.VIRTUAL_ATTRIBUTE_DESC : |
| JpaValidationDescriptionMessages.ATTRIBUTE_DESC; |
| attributeDescription = NLS.bind(attributeDescription, attribute.getName()); |
| parms = ArrayTools.add(parms, 0, attributeDescription); |
| return DefaultJpaValidationMessages.buildMessage( |
| IMessage.HIGH_SEVERITY, |
| msgID, |
| parms, |
| this, |
| this.getValidationTextRange() |
| ); |
| } |
| } |