SMILA 1.0 API documentation

org.eclipse.smila.importing.crawler.file.filter
Class FilterEvaluator

java.lang.Object
  extended by org.eclipse.smila.importing.crawler.file.filter.FilterEvaluator

public class FilterEvaluator
extends java.lang.Object

Applies configured filters to given files and folders.


Constructor Summary
FilterEvaluator()
           
 
Method Summary
 boolean applyFiltersForCrawledFile(java.io.File fileDir, java.io.File file)
           
 java.util.Collection<java.io.File> applyFiltersForCrawledFiles(java.io.File fileDir, java.util.Collection<java.io.File> files)
          filter out files that should not be crawled.
 boolean applyFiltersForCrawledFolder(java.io.File folder, java.lang.String rootFolder)
           
 java.util.Collection<java.io.File> applyFiltersForCrawledFolders(java.util.Collection<java.io.File> folders, java.lang.String rootFolder)
          filter out folders whose subfolders and files should not be crawled.
 void setFilterConfiguration(FilterConfiguration filterConfig)
          set 'null' to disable filtering.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterEvaluator

public FilterEvaluator()
Method Detail

applyFiltersForCrawledFiles

public java.util.Collection<java.io.File> applyFiltersForCrawledFiles(java.io.File fileDir,
                                                                      java.util.Collection<java.io.File> files)
                                                               throws java.io.IOException
filter out files that should not be crawled. (max size, file patterns, folder include patterns)

Throws:
java.io.IOException

applyFiltersForCrawledFile

public boolean applyFiltersForCrawledFile(java.io.File fileDir,
                                          java.io.File file)
                                   throws java.io.IOException
Returns:
'false' if file is filtered out, otherwise 'true'.
Throws:
java.io.IOException

applyFiltersForCrawledFolders

public java.util.Collection<java.io.File> applyFiltersForCrawledFolders(java.util.Collection<java.io.File> folders,
                                                                        java.lang.String rootFolder)
                                                                 throws java.io.IOException
filter out folders whose subfolders and files should not be crawled. (max depth, folder exclude patterns)

Throws:
java.io.IOException

applyFiltersForCrawledFolder

public boolean applyFiltersForCrawledFolder(java.io.File folder,
                                            java.lang.String rootFolder)
                                     throws java.io.IOException
Returns:
'false' if folder is filtered out, otherwise 'true'.
Throws:
java.io.IOException

setFilterConfiguration

public void setFilterConfiguration(FilterConfiguration filterConfig)
set 'null' to disable filtering.


SMILA 1.0 API documentation