// $Header: /home/cvs/jakarta-jmeter/src/jorphan/org/apache/jorphan/collections/SortedHashTree.java,v 1.7 2004/03/24 15:23:37 mstover1 Exp $
/*
 * Copyright 2001-2004 The Apache Software Foundation.
 *
 * 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.apache.jorphan.collections;

import java.io.Serializable;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.TreeMap;

//NOTUSED import org.apache.jorphan.logging.LoggingManager;
//NOTUSED import org.apache.log.Logger;

/**
 * SortedHashTree is a different implementation of the {@link HashTree}
 * collection class.  In the SortedHashTree, the ordering of values in the tree
 * is made explicit via the compare() function of objects added to the tree.
 * This works in exactly the same fashion as it does for a SortedSet.
 *
 * @see HashTree
 * @see HashTreeTraverser
 * 
 * @author    mstover1 at apache.org
 * @version   $Revision: 1.7 $
 */
public class SortedHashTree extends HashTree implements Serializable
{
    //NOTUSED private static Logger log = LoggingManager.getLoggerForClass();
    protected Comparator comparator;

    public SortedHashTree()
    {
        data = new TreeMap();
    }
    
    public SortedHashTree(Comparator comper)
    {
        comparator = comper;
        data = new TreeMap(comparator);
    }

    public SortedHashTree(Object key)
    {
        data = new TreeMap();
        data.put(key, new SortedHashTree());
    }
    
    public SortedHashTree(Object key,Comparator comper)
    {
        comparator = comper;
        data = new TreeMap(comparator);
        data.put(key, new SortedHashTree(comparator));
    }

    public SortedHashTree(Collection keys)
    {
        data = new TreeMap();
        Iterator it = keys.iterator();
        while (it.hasNext())
        {
            data.put(it.next(), new SortedHashTree());
        }
    }
    
    public SortedHashTree(Collection keys,Comparator comper)
    {
        comparator = comper;
        data = new TreeMap(comparator);
        Iterator it = keys.iterator();
        while (it.hasNext())
        {
            data.put(it.next(), new SortedHashTree(comparator));
        }
    }

    public SortedHashTree(Object[] keys)
    {
        data = new TreeMap();
        for (int x = 0; x < keys.length; x++)
        {
            data.put(keys[x], new SortedHashTree());
        }
    }
    
    public SortedHashTree(Object[] keys,Comparator comper)
    {
        comparator = comper;
        data = new TreeMap(comparator);
        for (int x = 0; x < keys.length; x++)
        {
            data.put(keys[x], new SortedHashTree(comparator));
        }
    }

    protected HashTree createNewTree()
    {
        if(comparator == null)
        {
            return new SortedHashTree();
        }
        else
        {
            return new SortedHashTree(comparator);
        }
    }

    protected HashTree createNewTree(Object key)
    {
        if(comparator == null)
        {
            return new SortedHashTree(key);
        }
        else
        {
            return new SortedHashTree(key,comparator);
        }
    }

    protected HashTree createNewTree(Collection values)
    {
        if(comparator == null)
        {
            return new SortedHashTree(values);
        }
        else
        {
            return new SortedHashTree(values,comparator);
        }
    }

    public Object clone()
    {
        HashTree newTree = null;
        if(comparator == null)
        {
            newTree = new SortedHashTree();
        }
        else
        {
            newTree = new SortedHashTree(comparator);
        }
        newTree.data = (Map) ((HashMap) data).clone();
        return newTree;
    }
    /**
     * @param comparator The comparator to set.
     */
    public void setComparator(Comparator comparator) {
        this.comparator = comparator;
    }
}