DirectoryCrawlerContext.java

/*
    Leech - crawling capabilities for Apache Tika
    
    Copyright (C) 2012 DFKI GmbH, Author: Christian Reuschling

    This program 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.

    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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

    Contact us by mail: christian.reuschling@dfki.de
*/

package de.dfki.km.leech.config;



import de.dfki.km.leech.parser.DirectoryCrawlerParser;



/**
 * This class gives a context / configuration for the crawling process, with additional configuration capabilities that are special to the
 * {@link DirectoryCrawlerParser}. Aspects as e.g. if the crawler should follow symbolic links or consider hidden files can be adjusted.<br>
 * <br>
 * Examples:<br>
 * <code>
 * CrawlerContext crawlerContext = new CrawlerContext().setIncrementalCrawlingHistoryPath("./history/forResourceDir");<br><br>
 * 
 * DirectoryCrawlerContext directoryCrawlerContext = new DirectoryCrawlerContext().setIgnoreHiddenFiles(false);<br><br>
 * ParseContext parseContext = new ParseContext();<br>
 * parseContext.set(CrawlerContext.class, crawlerContext);<br>
 * parseContext.set(DirectoryCrawlerContext.class, directoryCrawlerContext);<br>
 * 
 * 
 * @author Christian Reuschling, Dipl.Ing.(BA)
 */
public class DirectoryCrawlerContext
{

    protected boolean m_followSymbolicLinks = true;

    protected boolean m_ignoreHiddenFiles = true;




    /**
     * Gets whether the crawler should follow symbolic links or not. The default is false.
     * 
     * @return true: the crawler will follow symbolic links, false otherwise
     */
    public boolean getFollowSymbolicLinks()
    {
        return m_followSymbolicLinks;
    }



    /**
     * Gets whether the crawler ignores hidden files or not. The default is true.
     * 
     * @return true: the crawler will ignore hidden files, false otherwise
     */
    public boolean getIgnoreHiddenFiles()
    {
        return m_ignoreHiddenFiles;
    }



    /**
     * Specifies whether the crawler should follow symbolic links or not. The default is false.
     * 
     * @param followSymbolicLinks true: the crawler will follow symbolic links, false otherwise
     * 
     * @return this for convenience
     */
    public DirectoryCrawlerContext setFollowSymbolicLinks(boolean followSymbolicLinks)
    {
        m_followSymbolicLinks = followSymbolicLinks;

        return this;
    }



    /**
     * Specifies whether the crawler ignores hidden files or not. The default is true.
     * 
     * @param ignoreHiddenFiles true: the crawler will ignore hidden files, false otherwise
     * 
     * @return this for convenience
     */
    public DirectoryCrawlerContext setIgnoreHiddenFiles(boolean ignoreHiddenFiles)
    {
        m_ignoreHiddenFiles = ignoreHiddenFiles;

        return this;
    }

}