## Uses of Interface
org.crosswire.jsword.book.BookFilter

- Packages that use BookFilter
  Package | Description
  --- | ---
  org.crosswire.jsword.book | The Book package provides an interface to a real store of data.
  org.crosswire.jsword.book.install.sword | An implementation of an installer that can handle SWORD Books (Modules).
  org.crosswire.jsword.bridge | Command line programs to do useful things.
  org.crosswire.jsword.examples | Some examples of how to use the JSword API.
  org.crosswire.jsword.index.lucene | An implementation of an Index using Lucene.

- - ### Uses of BookFilter in org.crosswire.jsword.book

    Classes in org.crosswire.jsword.book that implement BookFilter
    Modifier and Type | Class and Description
    --- | ---
    `(package private) static class` | `BookFilters.AllBookFilter` Filter for all books
    `(package private) static class` | `BookFilters.BookCategoryFilter` Filter for books by category
    `static class` | `BookFilters.BookFeatureFilter` Filter for books by feature
    `(package private) static class` | `BookFilters.CustomBookFilter` Custom Filter
    `(package private) static class` | `BookFilters.NotBookCategoryFilter` Filter for books by category

    Fields in org.crosswire.jsword.book declared as BookFilter
    Modifier and Type | Field and Description
    --- | ---
    `private BookFilter` | DefaultBook.`filter` The filter against books that returns candidates.
    `private BookFilter` | BookFilterIterator.`filter` The value filter

    Methods in org.crosswire.jsword.book that return BookFilter
    Modifier and Type | Method and Description
    --- | ---
    `static BookFilter` | BookFilters.`both(BookFilter b1, BookFilter b2)` A filter that accepts Books that match two criteria.
    `static BookFilter` | BookFilters.`either(BookFilter b1, BookFilter b2)` A filter that accepts Books that match either of two criteria.
    `static BookFilter` | BookFilters.`getAll()` A simple default filter that returns everything
    `static BookFilter` | BookFilters.`getBibles()` A filter that accepts everything that implements Bible or Commentary, when commentaries are listed with Bibles.
    `static BookFilter` | BookFilters.`getBooksByDriver(BookDriver driver)` A filter that accepts Books that match by book driver.
    `static BookFilter` | BookFilters.`getCommentaries()` A filter that accepts everything that implements Commentary
    `static BookFilter` | BookFilters.`getCustom(String match)` A simple default filter that returns everything.
    `static BookFilter` | BookFilters.`getDailyDevotionals()` A filter that accepts everything that implements DailyDevotionals
    `static BookFilter` | BookFilters.`getDictionaries()` A filter that accepts everything that implements Dictionary
    `static BookFilter` | BookFilters.`getGeneralBooks()` A filter that accepts everything that implements GeneralBook
    `static BookFilter` | BookFilters.`getGlossaries()` A filter that accepts everything that implements Dictionary
    `static BookFilter` | BookFilters.`getGreekDefinitions()` A filter that accepts everything that is a Greek Definition Dictionary
    `static BookFilter` | BookFilters.`getGreekParse()` A filter that accepts everything that is a Greek Parse/Morphology Dictionary
    `static BookFilter` | BookFilters.`getHebrewDefinitions()` A filter that accepts everything that is a Hebrew Definition Dictionary
    `static BookFilter` | BookFilters.`getHebrewParse()` A filter that accepts everything that is a Hebrew Parse/Morphology Dictionary
    `static BookFilter` | BookFilters.`getMaps()` A filter that accepts everything that implements Maps
    `static BookFilter` | BookFilters.`getNonBibles()` A filter that accepts everything that's not a Bible or a Commentary, when commentaries are listed with Bibles.
    `static BookFilter` | BookFilters.`getOnlyBibles()` A filter that accepts everything that implements Bible.

    Methods in org.crosswire.jsword.book with parameters of type BookFilter
    Modifier and Type | Method and Description
    --- | ---
    `static BookFilter` | BookFilters.`both(BookFilter b1, BookFilter b2)` A filter that accepts Books that match two criteria.
    `static BookFilter` | BookFilters.`either(BookFilter b1, BookFilter b2)` A filter that accepts Books that match either of two criteria.
    `private static Map<Book,String>` | Defaults.`getBookMap(BookFilter filter)` Convert a filter into an array of names of Books that pass the filter.
    `List<Book>` | Books.`getBooks(BookFilter filter)`
    `List<Book>` | BookList.`getBooks(BookFilter filter)` Get a filtered list of all the Books.
    `List<Book>` | AbstractBookList.`getBooks(BookFilter filter)`

    Constructors in org.crosswire.jsword.book with parameters of type BookFilter
    Constructor and Description
    `BookFilterIterator(Iterable<Book> books, BookFilter filter)` Simple ctor
    `DefaultBook(BookList bookList, BookFilter bookFilter)`

  - ### Uses of BookFilter in org.crosswire.jsword.book.install.sword

    Methods in org.crosswire.jsword.book.install.sword with parameters of type BookFilter
    Modifier and Type | Method and Description
    --- | ---
    `List<Book>` | AbstractSwordInstaller.`getBooks(BookFilter filter)`

  - ### Uses of BookFilter in org.crosswire.jsword.bridge

    Methods in org.crosswire.jsword.bridge with parameters of type BookFilter
    Modifier and Type | Method and Description
    --- | ---
    `static List<Book>` | BookInstaller.`getInstalledBooks(BookFilter filter)` Get a list of installed books by BookFilter.
    `List<Book>` | BookInstaller.`getRepositoryBooks(String repositoryName, BookFilter filter)` Get a list of books in a repository by BookFilter.

  - ### Uses of BookFilter in org.crosswire.jsword.examples

    Classes in org.crosswire.jsword.examples that implement BookFilter
    Modifier and Type | Class and Description
    --- | ---
    `(package private) static class` | `APIExamples.MyBookFilter` A simple BookFilter that looks for a Bible by name.

    Methods in org.crosswire.jsword.examples with parameters of type BookFilter
    Modifier and Type | Method and Description
    --- | ---
    `private static List<Book>` | ReadEverything.`getBooks(BookFilter filter)`

  - ### Uses of BookFilter in org.crosswire.jsword.index.lucene

    Methods in org.crosswire.jsword.index.lucene with parameters of type BookFilter
    Modifier and Type | Method and Description
    --- | ---
    `static String` | IndexMetadata.`generateInstalledBooksIndexVersionReport(BookFilter filter)`