com.alee.extended.tree.AbstractExTreeDataProvider Maven / Gradle / Ivy

Go to download
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.extended.tree;

import com.alee.laf.tree.UniqueNode;
import com.alee.utils.compare.Filter;

import java.util.Comparator;

/**
 * Abstract data provider with implemented comparator and filter getters and setters.
 *
 * @author Mikle Garin
 */

public abstract class AbstractExTreeDataProvider implements ExTreeDataProvider
{
    /**
     * Children comparator.
     */
    protected Comparator comparator = null;

    /**
     * Children filter.
     */
    protected Filter filter = null;

    @Override
    public Comparator getChildrenComparator ( final E node )
    {
        return comparator;
    }

    /**
     * Sets children comparator for all nodes.
     *
     * @param comparator children comparator for all nodes
     */
    public void setChildrenComparator ( final Comparator comparator )
    {
        this.comparator = comparator;
    }

    @Override
    public Filter getChildrenFilter ( final E node )
    {
        return filter;
    }

    /**
     * Sets children filter for all nodes.
     *
     * @param filter children filter for all nodes
     */
    public void setChildrenFilter ( final Filter filter )
    {
        this.filter = filter;
    }

    /**
     * Returns false by default to allow children load requests.
     * It is recommended to override this behavior if you can easily determine whether node is leaf or not.
     *
     * @param node node
     * @return false
     */
    @Override
    public boolean isLeaf ( final E node )
    {
        return false;
    }
}