/*****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
****************************************************************/
package org.apache.cayenne.project.validation;
import org.apache.cayenne.map.DbAttribute;
import org.apache.cayenne.map.DbEntity;
import org.apache.cayenne.map.DbJoin;
import org.apache.cayenne.map.DbRelationship;
import org.apache.cayenne.util.Util;
import org.apache.cayenne.validation.ValidationResult;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
class DbRelationshipValidator extends ConfigurationNodeValidator {
void validate(DbRelationship relationship, ValidationResult validationResult) {
if (relationship.getTargetEntity() == null) {
addFailure(
validationResult,
relationship,
"DbRelationship '%s' has no target entity",
toString(relationship));
} else if (relationship.getJoins().isEmpty()) {
addFailure(
validationResult,
relationship,
"DbRelationship '%s' has no joins",
toString(relationship));
} else {
// validate joins
for (DbJoin join : relationship.getJoins()) {
if (join.getSource() == null && join.getTarget() == null) {
addFailure(
validationResult,
relationship,
"DbRelationship '%s' has a join with no source and target attributes selected",
toString(relationship));
} else if (join.getSource() == null) {
addFailure(
validationResult,
relationship,
"DbRelationship '%s' has a join with no source attribute selected",
toString(relationship));
} else if (join.getTarget() == null) {
addFailure(
validationResult,
relationship,
"DbRelationship '%s' has a join with no target attribute selected",
toString(relationship));
}
}
}
if (Util.isEmptyString(relationship.getName())) {
addFailure(validationResult, relationship, "Unnamed DbRelationship");
} else if (relationship.getSourceEntity().getAttribute(relationship.getName()) != null) {
// check if there are attributes having the same name
addFailure(
validationResult,
relationship,
"Name of DbRelationship '%s' conflicts with the name of one of DbAttributes in the same entity",
toString(relationship));
} else {
NameValidationHelper helper = NameValidationHelper.getInstance();
String invalidChars = helper.invalidCharsInDbPathComponent(relationship.getName());
if (invalidChars != null) {
addFailure(
validationResult,
relationship,
"Name of DbRelationship '%s' contains invalid characters: %s",
toString(relationship),
invalidChars);
}
}
checkForDuplicates(relationship, validationResult);
checkOnGeneratedStrategyConflict(relationship, validationResult);
checkToMany(relationship, validationResult);
}
private void checkToMany(DbRelationship relationship, ValidationResult validationResult) {
if (relationship != null && relationship.getReverseRelationship() != null) {
if (relationship.isToMany() && relationship.getReverseRelationship().isToMany()) {
addFailure(
validationResult,
relationship,
"Relationship '%s' and reverse '%s' are both toMany",
relationship.getName(), relationship.getReverseRelationship().getName());
}
}
checkTypesOfAttributesInRelationship(relationship, validationResult);
}
private void checkTypesOfAttributesInRelationship(DbRelationship relationship, ValidationResult validationResult) {
for (DbJoin join: relationship.getJoins()) {
if (join.getSource() != null && join.getTarget() != null
&& join.getSource().getType() != join.getTarget().getType()) {
addFailure(
validationResult,
relationship,
"Attributes '%s' and '%s' have different types in a relationship '%s'",
join.getSourceName(), join.getTargetName(), relationship.getName());
}
}
}
private void checkOnGeneratedStrategyConflict(DbRelationship relationship, ValidationResult validationResult) {
if (relationship.isToDependentPK()) {
Collection<DbAttribute> attributes = relationship.getTargetEntity().getGeneratedAttributes();
for (DbAttribute attribute : attributes) {
if (attribute.isGenerated()) {
addFailure(
validationResult,
relationship,
"'To Dep Pk' incompatible with Database-Generated on '%s' relationship",
toString(relationship));
}
}
}
}
/**
* Per CAY-1813, make sure two (or more) DbRelationships do not map to the
* same database path.
*/
private void checkForDuplicates(DbRelationship relationship, ValidationResult validationResult) {
if (relationship != null &&
relationship.getName() != null &&
relationship.getTargetEntityName() != null) {
String dbRelationshipPath =
relationship.getTargetEntityName() +
"." +
getJoins(relationship);
DbEntity entity = relationship.getSourceEntity();
for (DbRelationship comparisonRelationship : entity.getRelationships()) {
if (relationship != comparisonRelationship) {
String comparisonDbRelationshipPath =
comparisonRelationship.getTargetEntityName() +
"." +
getJoins(comparisonRelationship);
if (dbRelationshipPath.equals(comparisonDbRelationshipPath)) {
addFailure(validationResult,
relationship,
"DbEntity '%s' contains a duplicate DbRelationship mapping ('%s' -> '%s')",
entity.getName(),
relationship.getName(),
dbRelationshipPath);
return; // Duplicate found, stop.
}
}
}
}
}
private String getJoins(DbRelationship relationship) {
List<String> joins = new ArrayList<>();
for (DbJoin join : relationship.getJoins()) {
joins.add("[source=" + join.getSourceName() + ",target=" + join.getTargetName() + "]");
}
Collections.sort(joins);
return Util.join(joins, ",");
}
private String toString(DbRelationship relationship) {
if (relationship.getSourceEntity() == null) {
return "[null source entity]." + relationship.getName();
}
return relationship.getSourceEntity().getName() + "." + relationship.getName();
}
}