openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/meta/JDBCRelatedFieldOrder.java

/*
 * 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.openjpa.jdbc.meta;

import java.util.Comparator;

import org.apache.openjpa.jdbc.identifier.DBIdentifier;
import org.apache.openjpa.jdbc.sql.Joins;
import org.apache.openjpa.jdbc.sql.Select;
import org.apache.openjpa.lib.util.Localizer;
import org.apache.openjpa.util.MetaDataException;

/**
 * Use the database to order by a field in the related type.
 *
 * @author Abe White
 */
class JDBCRelatedFieldOrder implements JDBCOrder {
    private static final long serialVersionUID = 1L;

    private static final Localizer _loc = Localizer.forPackage
        (JDBCRelatedFieldOrder.class);

    private final FieldMapping _fm;
    private final boolean _asc;

    public JDBCRelatedFieldOrder(FieldMapping owner, FieldMapping rel,
        boolean asc) {
        if (!rel.isInDefaultFetchGroup() && !rel.isPrimaryKey())
            throw new MetaDataException(_loc.get("nondfg-field-orderable",
                owner, rel.getName()));

        _fm = rel;
        _asc = asc;
    }

    /**
     * @deprecated
     */
    @Deprecated
    @Override
    public String getName() {
        return _fm.getName();
    }

    @Override
    public DBIdentifier getIdentifier() {
        return DBIdentifier.newColumn(_fm.getName());
    }

    @Override
    public boolean isAscending() {
        return _asc;
    }

    @Override
    public Comparator<?> getComparator() {
        return null;
    }

    @Override
    public boolean isInRelation() {
        return true;
    }

    @Override
    public void order(Select sel, ClassMapping elem, Joins joins) {
        FieldMapping fm = _fm;
        if (elem != null) {
            fm = getOrderByField(elem, fm);
            if (fm == null)
                fm = elem.getFieldMapping(_fm.getIndex());
        }
        sel.orderBy(fm.getColumns(), _asc, joins, false);
    }

    private FieldMapping getOrderByField(ClassMapping elem, FieldMapping fm) {
        ClassMapping owner = (ClassMapping)_fm.getDefiningMetaData();
        if (owner.getDescribedType() == elem.getDescribedType())
            return elem.getFieldMapping(_fm.getIndex());
        else {
            FieldMapping fms[] = elem.getFieldMappings();
            for (FieldMapping fieldMapping : fms) {
                ValueMapping vm = (ValueMapping) fieldMapping.getValue();
                ClassMapping clm = (ClassMapping) vm.getEmbeddedMetaData();
                if (clm != null) {
                    if (clm.getDescribedType() == owner.getDescribedType()) {
                        return owner.getFieldMapping(_fm.getIndex());
                    }
                    else {
                        FieldMapping fm1 = getOrderByField(clm, fm);
                        if (fm1 != null)
                            return fm1;
                    }
                }
            }
        }
        return null;
    }
}