com.alee.extended.list.FileListModel 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.list;

import com.alee.laf.list.WebListModel;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Custom list model for WebFileList component.
 *
 * @author Mikle Garin
 */

public class FileListModel extends WebListModel
{
    /**
     * File elements cache lock.
     */
    private final Object elementsCacheLock = new Object ();

    /**
     * File elements cache.
     */
    private final Map elementsCache = new HashMap ();

    /**
     * Constructs empty file list model.
     */
    public FileListModel ()
    {
        super ();
    }

    /**
     * Constructs file list model with files from directory under the specified path.
     *
     * @param directoryPath directory path
     */
    public FileListModel ( final String directoryPath )
    {
        super ();
        setData ( directoryPath );
    }

    /**
     * Constructs file list model with files from the specified directory.
     *
     * @param directory directory
     */
    public FileListModel ( final File directory )
    {
        super ();
        setData ( directory );
    }

    /**
     * Constructs file list model with the specified files.
     *
     * @param data files array
     */
    public FileListModel ( final File[] data )
    {
        super ();
        setData ( data );
    }

    /**
     * Constructs file list model with the specified files.
     *
     * @param data files list
     */
    public FileListModel ( final List data )
    {
        super ();
        setData ( data );
    }

    /**
     * Clears file elements cache.
     */
    private void clearCache ()
    {
        synchronized ( elementsCacheLock )
        {
            for ( final Map.Entry entry : elementsCache.entrySet () )
            {
                entry.getValue ().setFile ( null );
            }
            elementsCache.clear ();
        }
    }

    /**
     * Returns FileElement for the specified file or null if it is not in the list.
     *
     * @param file file to process
     * @return FileElement for the specified file or null if it is not in the list
     */
    public FileElement getElement ( final File file )
    {
        return getElement ( file != null ? file.getAbsolutePath () : null );
    }

    /**
     * Returns FileElement for the file with specified path or null if it is not in the list.
     *
     * @param path file path to process
     * @return FileElement for the file with specified path or null if it is not in the list
     */
    public FileElement getElement ( final String path )
    {
        synchronized ( elementsCacheLock )
        {
            return elementsCache.get ( path );
        }
    }

    /**
     * Clears list data and fills it with files from directory under the specified path.
     *
     * @param directoryPath directory path to process
     */
    public void setData ( final String directoryPath )
    {
        clearCache ();
        setElements ( toElementsList ( getData ( new File ( directoryPath ) ) ) );
    }

    /**
     * Clears list data and fills it with files from the specified directory.
     *
     * @param directory directory to process
     */
    public void setData ( final File directory )
    {
        clearCache ();
        setElements ( toElementsList ( getData ( directory ) ) );
    }

    /**
     * Clears list data and fills it with specified files.
     *
     * @param data files array
     */
    public void setData ( final File[] data )
    {
        clearCache ();
        setElements ( toElementsList ( data ) );
    }

    /**
     * Clears list data and fills it with specified files.
     *
     * @param data files list
     */
    public void setData ( final List data )
    {
        clearCache ();
        setElements ( toElementsList ( data ) );
    }

    /**
     * Returns files under the specified directory.
     *
     * @param directory directory to process
     * @return files array
     */
    protected File[] getData ( final File directory )
    {
        if ( directory != null )
        {
            return directory.listFiles ();
        }
        else
        {
            return new File[ 0 ];
        }
    }

    /**
     * Converts File array into FileElement list.
     *
     * @param data File array to process
     * @return FileElement list
     */
    protected List toElementsList ( final File[] data )
    {
        final List elements = new ArrayList ( data != null ? data.length : 0 );
        if ( data != null )
        {
            for ( final File file : data )
            {
                final FileElement element = new FileElement ( file );
                elements.add ( element );
                synchronized ( elementsCacheLock )
                {
                    elementsCache.put ( file.getAbsolutePath (), element );
                }
            }
        }
        return elements;
    }

    /**
     * Converts File list into FileElement list.
     *
     * @param data File list to process
     * @return FileElement list
     */
    protected List toElementsList ( final List data )
    {
        final List elements = new ArrayList ( data != null ? data.size () : 0 );
        if ( data != null )
        {
            for ( final File file : data )
            {
                final FileElement element = new FileElement ( file );
                elements.add ( element );
                synchronized ( elementsCacheLock )
                {
                    elementsCache.put ( file.getAbsolutePath (), element );
                }
            }
        }
        return elements;
    }
}