org.appng.search

## Interface DocumentProvider

- All Known Implementing Classes:
    FileSystemProvider

      public interface DocumentProvider

  When building the global Lucene index for a `Site`, every `DocumentProvider` provided by the site's `Application`s is able to add/remove some `Document`s to be indexed.
  Author:
    Matthias Müller
  See Also:
    `Document`, `DocumentProducer`, `SearchProvider`

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<DocumentProducer>` | `getDocumentProducers(Site site, Application application)` Returns some `DocumentProducer`s to take into account when building the `Site`'s global lucene index.

- - ### Method Detail

    - #### getDocumentProducers

          Iterable<DocumentProducer> getDocumentProducers(Site site,
                                                          Application application)
                                                   throws InterruptedException,
                                                          TimeoutException

      Returns some `DocumentProducer`s to take into account when building the `Site`'s global lucene index.
      Parameters:
        `site` - the current `Site`
        `application` - the current `Application`
      Returns:
        some `DocumentProducer`s
      Throws:
        `InterruptedException`
        `TimeoutException`

Copyright © 2011–2023 aiticon GmbH. All rights reserved.