|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.bridge.DwrBridge
public class DwrBridge
The DWR DwrBridge adapts JSword to DWR. This is based upon APIExamples.
for license details.
The copyright to this program is held by it's authors.
Constructor Summary | |
---|---|
DwrBridge()
|
Method Summary | |
---|---|
private BookData |
getBookData(String bookInitials,
String reference,
int start,
int count)
Get BookData representing one or more Book entries, but capped to a maximum number of entries. |
int |
getCardinality(String bookInitials,
String reference)
Determine the size of this reference. |
String[][] |
getInstalledBooks(String filter)
Get a listing of all the available books. |
private SAXEventProvider |
getOSISProvider(String bookInitials,
String reference,
int start,
int count)
Obtain a SAX event provider for the OSIS document representation of one or more book entries. |
String |
getOSISString(String bookInitials,
String reference,
int start,
int count)
Obtain the OSIS representation from a book for a reference, pruning a reference to a limited number of keys. |
String[] |
getSwordPath()
For the sake of diagnostics, return the locations that JSword will look for books. |
private boolean |
isIndexed(Book book)
Determine whether the book can be searched, that is, whether the book is indexed. |
boolean |
isIndexed(String bookInitials)
Determine whether the named book can be searched, that is, whether the book is indexed. |
String[] |
match(String bookInitials,
String searchRequest,
int maxMatchCount)
Get close matches for a target in a book whose keys have a meaningful sort. |
String |
search(String bookInitials,
String searchRequest)
Get a reference list for a search result against a book. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DwrBridge()
Method Detail |
---|
public String[][] getInstalledBooks(String filter)
filter
- The custom filter specification string
BookInstaller.getInstalledBook(String)
public boolean isIndexed(String bookInitials)
bookInitials
- the named book to check.
public int getCardinality(String bookInitials, String reference) throws NoSuchKeyException
bookInitials
- the book to which the reference applies.reference
- the actual reference
NoSuchKeyException
public String getOSISString(String bookInitials, String reference, int start, int count) throws BookException, NoSuchKeyException
bookInitials
- the book to usereference
- a reference, appropriate for the book, for one or more keys
BookException
NoSuchKeyException
public String search(String bookInitials, String searchRequest) throws BookException
bookInitials
- searchRequest
-
BookException
public String[] match(String bookInitials, String searchRequest, int maxMatchCount)
public String[] getSwordPath()
private boolean isIndexed(Book book)
book
- the book to check.
private BookData getBookData(String bookInitials, String reference, int start, int count) throws NoSuchKeyException
bookInitials
- the book to usereference
- a reference, appropriate for the book, of one or more entriesstart
- the starting point where 0 is the first.count
- the maximum number of entries to use
NoSuchKeyException
private SAXEventProvider getOSISProvider(String bookInitials, String reference, int start, int count) throws BookException, NoSuchKeyException
bookInitials
- the book to usereference
- a reference, appropriate for the book, of one or more entries
BookException
NoSuchKeyException
|
Copyright ? 2003-2011 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |