SizeControlledSet.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2022 Marco Foscato <marco.foscato@uib.no>
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License as published
 *   by the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package denoptim.utils;
 
import java.io.File;
import java.io.IOException;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
 
import denoptim.exception.DENOPTIMException;
import denoptim.files.FileUtils;
import denoptim.io.DenoptimIO;
 
public class SizeControlledSet
{
    private int maxSize;
    
    private File dataOnDisk;
    
    private File allData;
    
    private boolean usingDisk = false;
    
    private int entriesInFile = 0;
    
    private Set<String> data;
    
//------------------------------------------------------------------------------
    
    public SizeControlledSet(int maxSize, String memoryFile, String allUIDsFile)
    {
        this.maxSize = maxSize;
        this.dataOnDisk = new File(memoryFile);
        if (allUIDsFile!=null)
            this.allData = new File(allUIDsFile);
        data = Collections.synchronizedSet(new HashSet<String>());
    }
    
//------------------------------------------------------------------------------
 
    public synchronized boolean addNewUniqueEntry(String entry) throws IOException
    {
        synchronized (data)
        {
            boolean wasNew = false;
            if (usingDisk)
            {
                if (data.contains(entry))
                {
                    return false;
                }
                wasNew = !FileUtils.isLineInTxtFile(entry, dataOnDisk, true);
                if (wasNew)
                {
                    entriesInFile++;
                }
            } else {
                wasNew = data.add(entry);
                if (data.size()>=maxSize)
                    usingDisk = true;
            }
            if (wasNew && allData!=null)
            {
                try
                {
                    DenoptimIO.writeData(allData.getAbsolutePath(), entry,
                            true);
                } catch (DENOPTIMException e)
                {
                    throw ((IOException) e.getCause());
                }
            }
            return wasNew;
        }
    }
    
//------------------------------------------------------------------------------
 
    public synchronized boolean contains(String entry) throws IOException
    {
        synchronized (data)
        {
            boolean foundInMemory = data.contains(entry);
            boolean foundInDisk = false;
            if (usingDisk && !foundInMemory)
            {
                foundInDisk = FileUtils.isLineInTxtFile(entry, dataOnDisk, 
                        false);
            }
            return foundInMemory || foundInDisk;
        }
    }
    
//------------------------------------------------------------------------------
    
    public synchronized int size()
    {
        synchronized (data)
        {
            return data.size() + entriesInFile;
        }
    }
 
//------------------------------------------------------------------------------
 
}