/*****************************************************************
 *   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 java.util.Iterator;

import org.apache.cayenne.map.DbJoin;
import org.apache.cayenne.map.DbRelationship;
import org.apache.cayenne.project.ProjectPath;
import org.apache.cayenne.util.Util;

/**
 * @author Andrus Adamchik
 */
public class DbRelationshipValidator extends TreeNodeValidator {

    /**
     * Constructor for DbRelationshipValidator.
     */
    public DbRelationshipValidator() {
        super();
    }

    public void validateObject(ProjectPath path, Validator validator) {
        DbRelationship rel = (DbRelationship) path.getObject();
        if (rel.getTargetEntity() == null) {
            validator.registerWarning("DbRelationship " + dbRelationshipIdentifier(rel) + " has no target entity.", path);
        }
        else if (rel.getJoins().size() == 0) {
            validator.registerWarning("DbRelationship " + dbRelationshipIdentifier(rel) + " has no joins.", path);
        }
        else {
            // validate joins
            Iterator joins = rel.getJoins().iterator();
            while (joins.hasNext()) {
                DbJoin join = (DbJoin) joins.next();
                if (join.getSource() == null && join.getTarget() == null) {
                    validator
                            .registerWarning(
                                    "DbRelationship " + dbRelationshipIdentifier(rel) + " join has no source and target attributes selected.",
                                    path);
                }
                else if (join.getSource() == null) {
                    validator.registerWarning(
                            "DbRelationship " + dbRelationshipIdentifier(rel) + " join has no source attribute selected.",
                            path);
                }
                else if (join.getTarget() == null) {
                    validator.registerWarning(
                            "DbRelationship " + dbRelationshipIdentifier(rel) + " join has no target attribute selected.",
                            path);
                }
            }
        }

        if (Util.isEmptyString(rel.getName())) {
            validator.registerError("Unnamed DbRelationship.", path);
        }
        // check if there are attributes having the same name
        else if (rel.getSourceEntity().getAttribute(rel.getName()) != null) {
            validator.registerError(
                    "DbRelationship " + dbRelationshipIdentifier(rel) + " has the same name as one of DbAttributes",
                    path);
        }
        else {
            MappingNamesHelper helper = MappingNamesHelper.getInstance();
            String invalidChars = helper.invalidCharsInDbPathComponent(rel.getName());

            if (invalidChars != null) {
                validator
                        .registerWarning(
                                "DbRelationship " + dbRelationshipIdentifier(rel) + " name contains invalid characters: "
                                        + invalidChars,
                                path);
            }
        }
    }
    
    public String dbRelationshipIdentifier(DbRelationship rel)
    {
        if (null == rel.getSourceEntity())
        {
            return "<[null source entity]." + rel.getName() + ">";
        }
        return "<" + rel.getSourceEntity().getName() + "." + rel.getName() + ">";
    }
}
