AbstractBookMetaData

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.crosswire.jsword.book.basic
Class AbstractBookMetaData

java.lang.Object
  org.crosswire.jsword.book.basic.AbstractBookMetaData

All Implemented Interfaces:: Comparable<BookMetaData>, BookMetaData

Direct Known Subclasses:: DefaultBookMetaData, SwordBookMetaData

public abstract class AbstractBookMetaData
extends Object
implements BookMetaData
extends Object
implements BookMetaData

Author:: DM Smith
See Also:: The GNU Lesser General Public License for details. The copyright to this program is held by its authors.

Field Summary
`private BookDriver`	`driver`
`private IndexStatus`	`indexStatus`
`private Language`	`language`
`private URI`	`library`
`private URI`	`location`

Fields inherited from interface org.crosswire.jsword.book.BookMetaData
`KEY_BOOK, KEY_BOOKLIST, KEY_CATEGORY, KEY_DRIVER, KEY_FONT, KEY_LANG, KEY_LANGUAGE, KEY_NAME, KEY_SCOPE, KEY_VERSIFICATION`

Constructor Summary
`AbstractBookMetaData()`

Method Summary
`int`	`compareTo(BookMetaData obj)`
`boolean`	`equals(Object obj)`
`BookDriver`	`getDriver()` Accessor for the driver that runs this Book.
`String`	`getDriverName()` Calculated field: The name of the name, which could be helpful to distinguish similar Books available through 2 BookDrivers.
`IndexStatus`	`getIndexStatus()` Has anyone generated a search index for this Book?
`KeyType`	`getKeyType()` How this Book organizes it's keys.
`Language`	`getLanguage()` The language of the book.
`URI`	`getLibrary()` Get the base URI for library of this module.
`URI`	`getLocation()` Get the base URI for relative URIs in the document.
`String`	`getOsisID()` Calculated field: Get an OSIS identifier for the OsisText.setOsisIDWork() and the Work.setOsisWork() methods.
`String`	`getUnlockKey()` Gets the unlock key for the module.
`boolean`	`hasFeature(FeatureType feature)` Return whether the feature is supported by the book.
`int`	`hashCode()`
`boolean`	`isEnciphered()` Indicate whether this book is enciphered.
`boolean`	`isLocked()` Indicate whether this book is enciphered and without a key.
`boolean`	`isQuestionable()` Indicate whether this book is questionable.
`boolean`	`isSupported()` Indicate whether this book is supported by JSword.
`void`	`putProperty(String key, String value)` Save to shared storage.
`void`	`setDriver(BookDriver driver)`
`void`	`setIndexStatus(IndexStatus newValue)` This method does not alter the index status, however it is for Indexers that are responsible for indexing and have changed the status themselves.
`void`	`setLanguage(Language language)` Set the language for this book.
`void`	`setLibrary(URI library)` Set the base URI for library of this module.
`void`	`setLocation(URI location)` Set the base URI for relative URIs in the document.
`org.jdom2.Document`	`toOSIS()` Get an OSIS representation of information concerning this Book.
`String`	`toString()`
`boolean`	`unlock(String unlockKey)` Unlocks a book with the given key.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.crosswire.jsword.book.BookMetaData
`getAbbreviation, getBookCategory, getInitials, getName, getProperty, getPropertyKeys, isLeftToRight, putProperty, setProperty`

Field Detail

driver

private BookDriver driver

indexStatus

private IndexStatus indexStatus

language

private Language language

library

private URI library

location

private URI location

Constructor Detail

AbstractBookMetaData

public AbstractBookMetaData()

Method Detail