/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.tasklist.compiler.treetable;

import java.util.Comparator;
import javax.swing.event.ChangeListener;

/**
 * todo 
 * @author Tim Lebedkov
 */
public interface SortingModel {
    /**
     * Provider for a SortingModel (TreeTable implements this interface)
     */
    public interface Provider {
        /**
         * todo
         */
        public SortingModel getSortingModel();
    }
    
    /**
     * Returns a comparator for the specified model column
     *
     * @param modelColumn column number
     * @return comparator or null if the column is not sortable
     */
    public Comparator getColumnComparator(int modelColumn);
    
    /**
     * Returns sorting order
     *
     * @return true = descending, false = ascending
     */
    public boolean isSortOrderDescending();
    
    /**
     * Sets sorting order
     *
     * @param d true = descending, false = ascending
     */
    public void setSortOrderDescending(boolean d);
    
    /**
     * Changes the sorted column
     *
     * @param index column number in the model or -1 if not sorted
     */
    public void setSortedColumn(int index);
    
    /**
     * Returns the sorted column
     *
     * @return column number in the model or -1 if not sorted
     */
    public int getSortedColumn();
    
    /**
     * Adds a listener
     *
     * @param l a listener
     */
    public void addChangeListener(ChangeListener l);
    
    /**
     * Removes a listener
     *
     * @param l a listener to be removed
     */
    public void removeChangeListener(ChangeListener l);
}