groovy/modules/grails/src/scaffolding/org/codehaus/groovy/grails/scaffolding/DomainClassPropertyComparator.java

/* Copyright 2004-2005 the original author or authors.
 * 
 * Licensed 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.codehaus.groovy.grails.scaffolding;

import org.codehaus.groovy.grails.validation.ConstrainedProperty;
import org.codehaus.groovy.grails.commons.GrailsDomainClass;
import org.codehaus.groovy.grails.commons.GrailsDomainClassProperty;

import java.util.Comparator;
import java.util.Map;

/**
 * Comparator that uses the domain class property constraints to establish order in sort methods and always
 * places the id first
 *
 * @author Graeme Rocher
 * @since 10-Feb-2006
 */
public class DomainClassPropertyComparator implements Comparator {
    private Map constrainedProperties;
    private GrailsDomainClass domainClass;

    public DomainClassPropertyComparator(GrailsDomainClass domainClass) {
        if(domainClass == null)
            throw new IllegalArgumentException("Argument 'domainClass' is required!");

        this.constrainedProperties = domainClass.getConstrainedProperties();
        this.domainClass = domainClass;
    }

    public int compare(Object o1, Object o2) {
        if(o1.equals(domainClass.getIdentifier()))
            return -1;
        else if(o2.equals(domainClass.getIdentifier()))
            return 1;

        GrailsDomainClassProperty prop1 = (GrailsDomainClassProperty)o1;
        GrailsDomainClassProperty prop2 = (GrailsDomainClassProperty)o2;

        ConstrainedProperty cp1 = (ConstrainedProperty)constrainedProperties.get(prop1.getName());
        ConstrainedProperty cp2 = (ConstrainedProperty)constrainedProperties.get(prop2.getName());

        if(cp1 == null & cp2 == null)
            return prop1.getName().compareTo(prop2.getName());
        if(cp1 == null)
            return 1;
        else if(cp2 == null)
            return -1;
        else {
            if(cp1.getOrder() > cp2.getOrder())
                return 1;
            else if(cp1.getOrder() < cp2.getOrder())
                return -1;
            else
                return 0;
        }
    }
}