/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotools.data.joining;

import java.util.List;

import org.geotools.data.Query;
import org.opengis.filter.expression.Expression;
import org.opengis.filter.sort.SortBy;

/**
 * 
 * Special Query that includes joining information
 * 
 * @author Niels Charlier (Curtin University of Technology)
 *
 */
public class JoiningQuery extends Query {
    
    public static class Join {
        protected String joiningTypeName;    
        protected Expression foreignKeyName;    
        protected Expression joiningKeyName;
        protected SortBy[] sortBy;
                
        public String getJoiningTypeName() {
            return joiningTypeName;
        }

        public void setJoiningTypeName(String joiningTypeName) {
            this.joiningTypeName = joiningTypeName;
        }

        public Expression getForeignKeyName() {
            return foreignKeyName;
        }
        
        public SortBy[] getSortBy() {
            return sortBy;
        }

        public void setForeignKeyName(Expression foreignKeyName) {
            this.foreignKeyName = foreignKeyName;
        }

        public Expression getJoiningKeyName() {
            return joiningKeyName;
        }

        public void setJoiningKeyName(Expression joiningKeyName) {
            this.joiningKeyName = joiningKeyName;
        }
        
        public void setSortBy(SortBy[] sortBy){
            this.sortBy = sortBy;
        }
    }
    
    protected List<Join> joins;
    
    
    public JoiningQuery(JoiningQuery query) {
        super(query);
        setJoins(query.getJoins());
    }
    
    public JoiningQuery(Query query){
        super(query);
    }
    
    public JoiningQuery() {
    }   
    
    public void setJoins(List<Join> joins){
        this.joins = joins;
    }
    
    public List<Join> getJoins(){
        return joins;
    }

}