Changes between Initial Version and Version 1 of ApertureDataCrawlerListener


Ignore:
Timestamp:
Oct 14, 2005, 10:55:59 AM (21 years ago)
Author:
sauermann
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ApertureDataCrawlerListener

    v1 v1  
     1{{{
     2
     3/**
     4 * A listener for events from a DataCrawler.
     5 **/
     6public interface DataCrawlerListener {
     7
     8        /**
     9         * Notification that the specified DataCrawler has started
     10         * scanning its domain for data objects.
     11         *
     12         * @param dataSource The concerning data source.
     13         **/
     14        public void scanStarted(DataCrawler dataCrawler);
     15
     16        /**
     17         * Notification that the specified DataCrawler has stopped
     18         * scanning its DataSource for DataObjects. The crawler might
     19         * have completed scanning its domain, it might have been
     20         * requested to stop by someone or it might have stopped
     21     * because of a fatal exception.
     22         *
     23         * @param dataSource The concerning DataCrawler.
     24         * @param exitCode The status with which the scan method stopped.
     25         **/
     26        public void scanStopped(DataCrawler dataCrawler, DataCrawler.ExitCode exitCode);
     27
     28        /**
     29         * Notification that the DataCrawler is going to start scanning
     30         * the specified data object.
     31         *
     32         * @param url The url of the data object that is going to be scanned.
     33         **/
     34        public void scanningObject(DataCrawler dataCrawler, String url);
     35
     36        /**
     37         * Notification that the DataCrawler has found a new or changed
     38         * DataObject in its scan domain.
     39         *
     40         * @param dataObject The DataObject that has been constructed.
     41         * @param newObject Flag indicating whether the scanned object is
     42         * new (true) or that it has been scanned before but has
     43         * changed (false).
     44         **/
     45        public void objectScanned(DataCrawler dataCrawler, DataObject dataObject, boolean newObject);
     46
     47        /**
     48         * Notification that the DataCrawler has found a data object that
     49         * has not been modified since the previous scan.
     50         *
     51         * @param url The url of the unmodified data object.
     52         **/
     53        public void objectNotModified(DataCrawler dataCrawler, String url);
     54
     55        /**
     56         * Notification that the data object with the specified
     57         * url that was found in an earlier scan could no longer
     58         * be found in this scan. This may indicate that the physical
     59     * resource no longer exists or that it now falls outside the defined domain.
     60         *
     61         * @param id The id of the data object that could no longer be found.
     62         **/
     63        public void objectRemoved(DataCrawler dataCrawler, String url);
     64
     65        /**
     66         * Notification that the specified DataCrawler has started
     67         * clearing its scan results cache.
     68         *
     69         * @param dataSource The concerning DataCrawler.
     70         **/
     71        public void clearStarted(DataCrawler dataCrawler);
     72
     73        /**
     74         * Notification that the specified DataCrawler has finished
     75         * clearing its scan results cache.
     76         *
     77         * @param dataSource The concerning DataCrawler.
     78         **/
     79        public void clearFinished(DataCrawler dataCrawler);
     80
     81        /**
     82         * Notification that the data object with the specified url
     83         * is going to be removed from the DataCrawler's scan results cache.
     84         * This method is typically called at the start of a full rescan.
     85         **/
     86        public void clearingObject(DataCrawler dataCrawler, String url);
     87}
     88
     89}}}