/*****************************************************************
* 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.validator;
import org.apache.cayenne.access.DataDomain;
import org.apache.cayenne.map.DataMap;
import org.apache.cayenne.map.ObjEntity;
import org.apache.cayenne.project.ProjectPath;
import org.apache.cayenne.util.Util;
/**
*/
public class ObjEntityValidator extends TreeNodeValidator {
/**
* Constructor for ObjEntityValidator.
*/
public ObjEntityValidator() {
super();
}
@Override
public void validateObject(ProjectPath path, Validator validator) {
ObjEntity ent = (ObjEntity) path.getObject();
validateName(ent, path, validator);
validateClassName(ent, path, validator);
validateSuperClassName(ent, path, validator);
// validate DbEntity presence
if (ent.getDbEntity() == null && !ent.getIsAbstract()) {
validator.registerWarning("ObjEntity has no DbEntity mapping.", path);
}
}
private void validateClassName(ObjEntity ent, ProjectPath path, Validator validator) {
String className = ent.getClassName();
// if mapped to default class, ignore...
if (Util.isEmptyString(className)) {
return;
}
MappingNamesHelper helper = MappingNamesHelper.getInstance();
String invalidChars = helper.invalidCharsInJavaClassName(className);
if (invalidChars != null) {
validator.registerWarning(
"ObjEntity Java class contains invalid characters: " + invalidChars,
path);
}
else if (helper.invalidDataObjectClass(className)) {
validator.registerWarning(
"ObjEntity Java class is invalid: " + className,
path);
}
else if (className.indexOf('.') < 0) {
validator.registerWarning(
"Placing Java class in default package is discouraged: " + className,
path);
}
}
private void validateSuperClassName(
ObjEntity ent,
ProjectPath path,
Validator validator) {
String superClassName = ent.getSuperClassName();
if (Util.isEmptyString(superClassName)) {
return; // null is Ok
}
MappingNamesHelper helper = MappingNamesHelper.getInstance();
String invalidChars = helper.invalidCharsInJavaClassName(superClassName);
if (invalidChars != null) {
validator.registerWarning(
"ObjEntity Java superclass contains invalid characters: "
+ invalidChars,
path);
}
else if (helper.invalidDataObjectClass(superClassName)) {
validator.registerWarning("ObjEntity Java superclass is invalid: "
+ superClassName, path);
}
DataMap map = (DataMap) path.getObjectParent();
if (map == null) {
return;
}
}
protected void validateName(ObjEntity entity, ProjectPath path, Validator validator) {
String name = entity.getName();
// Must have name
if (Util.isEmptyString(name)) {
validator.registerError("Unnamed ObjEntity.", path);
return;
}
DataMap map = (DataMap) path.getObjectParent();
if (map == null) {
return;
}
// check for duplicate names in the parent context
for (ObjEntity otherEnt : map.getObjEntities()) {
if (otherEnt == entity) {
continue;
}
if (name.equals(otherEnt.getName())) {
validator.registerError("Duplicate ObjEntity name: " + name + ".", path);
break;
}
}
// check for dupliucates in other DataMaps
DataDomain domain = path.firstInstanceOf(DataDomain.class);
if (domain != null) {
for (DataMap nextMap : domain.getDataMaps()) {
if (nextMap == map) {
continue;
}
ObjEntity conflictingEntity = nextMap.getObjEntity(name);
if (conflictingEntity != null) {
if (!Util.nullSafeEquals(conflictingEntity.getClassName(), entity
.getClassName())) {
validator.registerWarning(
"Duplicate ObjEntity name in another DataMap: "
+ name
+ ".",
path);
break;
}
}
}
}
}
}