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

- Packages that use BookMetaData
  Package | Description
  --- | ---
  org.crosswire.jsword.book | The Book package provides an interface to a real store of data.
  org.crosswire.jsword.book.basic | The Basic package contains default and abstract implementations of the main Book classes.
  org.crosswire.jsword.book.sword | An implementation of the Book interfaces that reads from SWORD project books (modules).
  org.crosswire.jsword.book.sword.state | File management of SWORD Books.
  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 BookMetaData in org.crosswire.jsword.book

    Methods in org.crosswire.jsword.book that return BookMetaData
    Modifier and Type | Method and Description
    --- | ---
    `BookMetaData` | Book.`getBookMetaData()` Meta-Information: What version of the Bible is this?

    Methods in org.crosswire.jsword.book with parameters of type BookMetaData
    Modifier and Type | Method and Description
    --- | ---
    `static org.jdom2.Element` | OSISUtil.`createOsisFramework(BookMetaData bmd)` Helper method to create the boilerplate headers in an OSIS document from the current metadata object
    `void` | Book.`setBookMetaData(BookMetaData bmd)` Set the meta-information for this book.

  - ### Uses of BookMetaData in org.crosswire.jsword.book.basic

    Classes in org.crosswire.jsword.book.basic that implement BookMetaData
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractBookMetaData`
    `class` | `DefaultBookMetaData` DefaultBookMetaData is an implementation of the of the BookMetaData interface.

    Fields in org.crosswire.jsword.book.basic declared as BookMetaData
    Modifier and Type | Field and Description
    --- | ---
    `private BookMetaData` | AbstractBook.`bmd` The meta data for this book

    Methods in org.crosswire.jsword.book.basic that return BookMetaData
    Modifier and Type | Method and Description
    --- | ---
    `BookMetaData` | AbstractBook.`getBookMetaData()`

    Methods in org.crosswire.jsword.book.basic with parameters of type BookMetaData
    Modifier and Type | Method and Description
    --- | ---
    `int` | AbstractBookMetaData.`compareTo(BookMetaData obj)`
    `void` | AbstractBook.`setBookMetaData(BookMetaData bmd)`

    Constructors in org.crosswire.jsword.book.basic with parameters of type BookMetaData
    Constructor and Description
    `AbstractBook(BookMetaData bmd, Backend backend)` Construct an AbstractBook given the BookMetaData and the AbstractBackend.
    `AbstractPassageBook(BookMetaData bmd, Backend backend)` Construct an AbstractPassageBook given the BookMetaData and the AbstractBackend.

  - ### Uses of BookMetaData in org.crosswire.jsword.book.sword

    Classes in org.crosswire.jsword.book.sword that implement BookMetaData
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SwordBookMetaData` A utility class for loading and representing Sword book configs.

    Methods in org.crosswire.jsword.book.sword that return BookMetaData
    Modifier and Type | Method and Description
    --- | ---
    `BookMetaData` | Backend.`getBookMetaData()`
    `BookMetaData` | AbstractBackend.`getBookMetaData()`

    Methods in org.crosswire.jsword.book.sword with parameters of type BookMetaData
    Modifier and Type | Method and Description
    --- | ---
    `static URI` | SwordUtil.`getExpandedDataPath(BookMetaData bookMetaData)` Returns where the book should be located

  - ### Uses of BookMetaData in org.crosswire.jsword.book.sword.state

    Fields in org.crosswire.jsword.book.sword.state declared as BookMetaData
    Modifier and Type | Field and Description
    --- | ---
    `private BookMetaData` | AbstractOpenFileState.`bookMetaData` The BookMetaData for this OpenFileState.

    Fields in org.crosswire.jsword.book.sword.state with type parameters of type BookMetaData
    Modifier and Type | Field and Description
    --- | ---
    `private Map<BookMetaData,Queue<OpenFileState>>` | OpenFileStateManager.`metaToStates`

    Methods in org.crosswire.jsword.book.sword.state that return BookMetaData
    Modifier and Type | Method and Description
    --- | ---
    `BookMetaData` | OpenFileState.`getBookMetaData()`
    `BookMetaData` | AbstractOpenFileState.`getBookMetaData()` Get the BookMetaData for this OpenFileState.

    Methods in org.crosswire.jsword.book.sword.state with parameters of type BookMetaData
    Modifier and Type | Method and Description
    --- | ---
    `GenBookBackendState` | OpenFileStateManager.`getGenBookBackendState(BookMetaData metadata)`
    `private <T extends OpenFileState> T` | OpenFileStateManager.`getInstance(BookMetaData metadata)`
    `private Queue<OpenFileState>` | OpenFileStateManager.`getQueueForMeta(BookMetaData metadata)`
    `RawBackendState` | OpenFileStateManager.`getRawBackendState(BookMetaData metadata)`
    `RawFileBackendState` | OpenFileStateManager.`getRawFileBackendState(BookMetaData metadata)`
    `RawLDBackendState` | OpenFileStateManager.`getRawLDBackendState(BookMetaData metadata)`
    `ZLDBackendState` | OpenFileStateManager.`getZLDBackendState(BookMetaData metadata)`
    `ZVerseBackendState` | OpenFileStateManager.`getZVerseBackendState(BookMetaData metadata, BlockType blockType)`

    Constructors in org.crosswire.jsword.book.sword.state with parameters of type BookMetaData
    Constructor and Description
    `AbstractOpenFileState(BookMetaData bmd)` Create an AbstractOpenFileState tied to a BookMetaData.
    `GenBookBackendState(BookMetaData bookMetaData)` This is default package access for forcing the use of the OpenFileStateManager to manage the creation.
    `RawBackendState(BookMetaData bookMetaData)` This is default package access for forcing the use of the OpenFileStateManager to manage the creation.
    `RawFileBackendState(BookMetaData bookMetaData)` This is default package access for forcing the use of the OpenFileStateManager to manage the creation.
    `RawLDBackendState(BookMetaData bookMetaData)` This is default package access for forcing the use of the OpenFileStateManager to manage the creation.
    `ZLDBackendState(BookMetaData bookMetaData)` This is default package access for forcing the use of the OpenFileStateManager to manage the creation.
    `ZVerseBackendState(BookMetaData bookMetaData, BlockType blockType)` This is default package access for forcing the use of the OpenFileStateManager to manage the creation.

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

    Methods in org.crosswire.jsword.examples with parameters of type BookMetaData
    Modifier and Type | Method and Description
    --- | ---
    `private void` | DictToOsis.`buildDocumentOpen(StringBuffer buf, BookMetaData bmd)`
    `private void` | BibleToOsis.`buildDocumentOpen(StringBuffer buf, BookMetaData bmd, String range, boolean force)`

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

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