fr.cnes.sirius.patrius.data

Class DirectoryCrawler

java.lang.Object

fr.cnes.sirius.patrius.data.DirectoryCrawler

All Implemented Interfaces:

DataProvider, Serializable

public class DirectoryCrawler
extends Object
implements DataProvider

Provider for data files stored in a directories tree on filesystem.

This class handles data files recursively starting from a root directories tree. The organization of files in the directories is free. There may be sub-directories to any level. All sub-directories are browsed and all terminal files are checked for loading.

Gzip-compressed files are supported.

Zip archives entries are supported recursively.

This is a simple application of the visitor design pattern for directory hierarchy crawling.

Author:

Luc Maisonobe

See Also:

DataProvidersManager, Serialized Form

Field Summary

Fields inherited from interface fr.cnes.sirius.patrius.data.DataProvider

GZIP_FILE_PATTERN, ZIP_ARCHIVE_PATTERN

Constructor Summary

Constructors

Constructor and Description
DirectoryCrawler(File rootIn) Build a data files crawler.

Method Summary

Modifier and Type	Method and Description
boolean	feed(Pattern supported, DataLoader visitor) Feed a data file loader by browsing the data collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirectoryCrawler

public DirectoryCrawler(File rootIn)
                 throws PatriusException

Build a data files crawler.

Parameters:

rootIn - root of the directories tree (must be a directory)

Throws:

PatriusException - if root is not a directory

Method Detail

feed

public boolean feed(Pattern supported,
                    DataLoader visitor)
             throws PatriusException

Feed a data file loader by browsing the data collection.

The method crawls all files referenced in the instance (for example all files in a directories tree) and for each file supported by the file loader it asks the file loader to load it.

If the method completes without exception, then the data loader is considered to have been fed successfully and the top level data providers manager will return immediately without attempting to use the next configured providers.

If the method completes abruptly with an exception, then the top level data providers manager will try to use the next configured providers, in case another one can feed the data loader.

Specified by:

feed in interface DataProvider

Parameters:

supported - pattern for file names supported by the visitor

visitor - data file visitor to use

Returns:

true if some data has been loaded

Throws:

PatriusException - if the data loader cannot be fed (read error ...)