A B C D E F G H I J L N O R S T U V W

A

add(Object...) - Method in class org.jqurantree.analysis.AnalysisTable
Adds a new row to the analysis table using of the specified values.
add(CharacterType) - Method in class org.jqurantree.arabic.ArabicTextBuilder
Appends a new character to the end of the buffer.
add(DiacriticType) - Method in class org.jqurantree.arabic.ArabicTextBuilder
Attaches a diacritic to the last character in the buffer.
add(CharacterType, DiacriticType...) - Method in class org.jqurantree.arabic.ArabicTextBuilder
Appends a new character with attached diacritics to the end of the buffer.
addItem(UnicodeType, char, CharacterType) - Method in class org.jqurantree.arabic.encoding.EncodingTableBase
Adds an Arabic character to the table.
addItem(UnicodeType, char, DiacriticType) - Method in class org.jqurantree.arabic.encoding.EncodingTableBase
Adds a diacritic to the table.
addItem(UnicodeType, char, CharacterType, DiacriticType) - Method in class org.jqurantree.arabic.encoding.EncodingTableBase
Adds an Arabic character with an attached diacritic to the table.
addWhitespace() - Method in class org.jqurantree.arabic.ArabicTextBuilder
Appends a space character to the end of the buffer.
AnalysisTable - Class in org.jqurantree.analysis
The AnalyisTable is a general purpose class which may be used to tabulate, sort, group and export results.
AnalysisTable(String...) - Constructor for class org.jqurantree.analysis.AnalysisTable
Creates an empty analysis table with the specified columns and without any rows.
ArabicCharacter - Class in org.jqurantree.arabic
An ArabicCharacter is a single letter or Quranic symbol within ArabicText, including any attached diacritics.
ArabicDecoder - Interface in org.jqurantree.arabic.encoding
Interface for classes which decode ArabicText.
ArabicDecoderBase - Class in org.jqurantree.arabic.encoding
ArabicDecoderBase is an abstract base class providing a common implementation for ArabicText decoders.
ArabicDecoderBase(EncodingTableBase) - Constructor for class org.jqurantree.arabic.encoding.ArabicDecoderBase
Creates a new decoder using the specified encoding table.
ArabicEncoder - Interface in org.jqurantree.arabic.encoding
Interface for classes which encode ArabicText.
ArabicEncoderBase - Class in org.jqurantree.arabic.encoding
ArabicEncoderBase is an abstract base class providing a common implementation for ArabicText encoders.
ArabicEncoderBase() - Constructor for class org.jqurantree.arabic.encoding.ArabicEncoderBase
Creates a new encoder.
ArabicEncoderBase(EncodingTableBase) - Constructor for class org.jqurantree.arabic.encoding.ArabicEncoderBase
Creates a new encoder using the specified encoding table.
ArabicText - Class in org.jqurantree.arabic
ArabicText is an immutable sequence of ArabicCharacters.
ArabicText(byte[], int, int) - Constructor for class org.jqurantree.arabic.ArabicText
Used internally to create a new Arabic text instance, when constructing the orthography model.
ArabicText(String) - Constructor for class org.jqurantree.arabic.ArabicText
Creates a new Arabic text instance from Unicode character data.
ArabicTextBuilder - Class in org.jqurantree.arabic
The ArabicTextBuilder class is used to construct ArabicText by wrapping a mutable sequence of ArabicCharacters.
ArabicTextBuilder() - Constructor for class org.jqurantree.arabic.ArabicTextBuilder
Creates a new Arabic text builder with the default initial capacity.
ArabicTextBuilder(int) - Constructor for class org.jqurantree.arabic.ArabicTextBuilder
Creates a new Arabic text builder with the specified character capacity.
ArrayIterator<T> - Class in org.jqurantree.core.collections
Supports iterating over an array without modifying the underlying values.
ArrayIterator(T[]) - Constructor for class org.jqurantree.core.collections.ArrayIterator
 

B

BuckwalterDecoder - Class in org.jqurantree.arabic.encoding.buckwalter
Supports decoding Buckwalter transliteration into ArabicText.
BuckwalterDecoder() - Constructor for class org.jqurantree.arabic.encoding.buckwalter.BuckwalterDecoder
Creates a new Buckwalter decoder.
BuckwalterEncoder - Class in org.jqurantree.arabic.encoding.buckwalter
Supports encoding ArabicText into Buckwalter transliteration.
BuckwalterEncoder() - Constructor for class org.jqurantree.arabic.encoding.buckwalter.BuckwalterEncoder
Creates a new Buckwalter encoder.
buffer - Variable in class org.jqurantree.arabic.ArabicText
The byte[] buffer holding the character data.
ByteFormat - Class in org.jqurantree.arabic
ByteFormat is a support class which is used to decode the internal byte format of ArabicText.

C

Chapter - Class in org.jqurantree.orthography
One of the 114 chapters in the Holy Quran, with a unique chapter name and number.
Chapter(int, ArabicText, ArabicText, Verse[]) - Constructor for class org.jqurantree.orthography.Chapter
Creates a new chapter, used by JQuranTree when constructing the orthography model.
CHARACTER_WIDTH - Static variable in class org.jqurantree.arabic.ByteFormat
The number of bytes representing each ArabicCharacter in the buffer.
characterCount - Variable in class org.jqurantree.arabic.ArabicText
The number of characters in the text.
CharacterType - Enum in org.jqurantree.arabic
The CharacterType enumeration specifies which letter or symbol an ArabicCharacter has, such as Alif or Ba.
close() - Method in class org.jqurantree.core.io.FileWriter
Closes the resource.
close() - Method in class org.jqurantree.core.resource.ResourceReader
Closes the resource.

D

decode(String) - Method in interface org.jqurantree.arabic.encoding.ArabicDecoder
Decodes a plain text string into the internal ByteFormat according to the encoding scheme.
decode(String) - Method in class org.jqurantree.arabic.encoding.ArabicDecoderBase
 
DiacriticType - Enum in org.jqurantree.arabic
The DiacriticType enumeration specifies the type of diaciritcs attached to an ArabicCharacter, such as Fatha or Kasra.
Document - Class in org.jqurantree.orthography
The top-level class in the orthography model, providing a structured representation of the entire text of the Holy Quran.

E

encode(byte[], int, int, EncodingOptions) - Method in interface org.jqurantree.arabic.encoding.ArabicEncoder
Encodes the internal ByteFormat into plain text according to the encoding scheme.
encode(byte[], int, int, EncodingOptions) - Method in class org.jqurantree.arabic.encoding.ArabicEncoderBase
 
encodeCharacter(byte[], int) - Method in class org.jqurantree.arabic.encoding.ArabicEncoderBase
Encodes a single ArabicCharacter in the internal ByteFormat.
encodeCharacter(byte[], int) - Method in class org.jqurantree.arabic.encoding.simple.SimpleEncoder
 
EncodingFactory - Class in org.jqurantree.arabic.encoding
The EncodingFactory supports the creation of ArabicEncoder and ArabicDecoder instances.
EncodingOptions - Enum in org.jqurantree.arabic.encoding
The EncodingOptions enumeration specifies which options to use when encoding or decoding ArabicText.
EncodingTableBase - Class in org.jqurantree.arabic.encoding
EncodingTableBase provides a common implementation for tables used by table-driven encoders and decoders of ArabicText.
EncodingTableBase() - Constructor for class org.jqurantree.arabic.encoding.EncodingTableBase
Creates a new encoding table instance.
EncodingType - Enum in org.jqurantree.arabic.encoding
The EncodingType enumeration specifies which encoding scheme to use when encoding or decoding ArabicText.
Errors - Class in org.jqurantree.core.error
Utility class which contains the list of error messages generated by the API when throwing exceptions.

F

FILE_NOT_FOUND - Static variable in class org.jqurantree.core.error.Errors
"The specified file could not be found."
FileWriter - Class in org.jqurantree.core.io
Utility class which supports writing to a file.
FileWriter(String) - Constructor for class org.jqurantree.core.io.FileWriter
Creates a new file writer by opening the specified file for writing.
findSubstring(String) - Method in class org.jqurantree.search.TokenSearch
Adds a substring match to the list of search criteria.
findSubstring(String, SearchOptions) - Method in class org.jqurantree.search.TokenSearch
Adds a substring match to the list of search criteria.
findToken(String) - Method in class org.jqurantree.search.TokenSearch
Adds an exact string match to the list of search criteria.
findToken(String, SearchOptions) - Method in class org.jqurantree.search.TokenSearch
Adds an exact string match to the list of search criteria, with search options.
fromBuckwalter(String) - Static method in class org.jqurantree.arabic.ArabicText
Converts Buckwalter transliteration into Arabic text.
fromEncoding(String, EncodingType) - Static method in class org.jqurantree.arabic.ArabicText
Decodes a string into Arabic text, according to the specified encoding scheme.
fromUnicode(String) - Static method in class org.jqurantree.arabic.ArabicText
Converts Unicode character data into Arabic text.

G

getBismillah() - Method in class org.jqurantree.orthography.Chapter
Gets the bismillah phrase preceding the chapter's verses.
getChapter(int) - Static method in class org.jqurantree.orthography.Document
Gets a chapter in the document by chapter number.
getChapter(Location) - Static method in class org.jqurantree.orthography.Document
Gets a chapter in the document by Location reference.
getChapter() - Method in class org.jqurantree.orthography.Token
Gets the chapter that contains the token.
getChapter() - Method in class org.jqurantree.orthography.Verse
Gets the chapter that contains the verse.
getChapterCount() - Static method in class org.jqurantree.orthography.Document
Gets the number of the chapters in the document.
getChapterNumber() - Method in class org.jqurantree.orthography.Chapter
Gets the chapter number.
getChapterNumber() - Method in class org.jqurantree.orthography.Location
Gets the chapter number.
getChapterNumber() - Method in class org.jqurantree.orthography.Token
Gets the chapter number.
getChapterNumber() - Method in class org.jqurantree.orthography.Verse
Gets the chapter number.
getChapters() - Static method in class org.jqurantree.orthography.Document
Gets an iterator used to enumerate over all chapters in the document.
getCharacter(int) - Method in class org.jqurantree.arabic.ArabicText
Gets the ArabicCharacter at the specified index.
getCharacter(CharacterType) - Method in class org.jqurantree.arabic.encoding.EncodingTableBase
Gets an output character in the table by Arabic character type.
getCharacter(UnicodeType) - Method in class org.jqurantree.arabic.encoding.EncodingTableBase
Gets an output character in the table by Unicode character type.
getCharacterType(int) - Method in class org.jqurantree.arabic.ArabicText
Gets the type of ArabicCharacter at the specified index.
getColumnCount() - Method in class org.jqurantree.analysis.AnalysisTable
Gets the number of columns in the table.
getColumnIndex(String) - Method in class org.jqurantree.analysis.AnalysisTable
Gets the index of a column in the table, by column name.
getColumnName(int) - Method in class org.jqurantree.analysis.AnalysisTable
Gets the name of a column in the table, by column index.
getDecoder(EncodingType) - Static method in class org.jqurantree.arabic.encoding.EncodingFactory
Gets a new ArabicDecoder instance for the specified encoding scheme.
getDiacriticCount() - Method in class org.jqurantree.arabic.ArabicCharacter
Gets the number of diacritics attached to the character.
getDiacriticCount(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Gets the number of diacritics attached to the character.
getEncoder(EncodingType) - Static method in class org.jqurantree.arabic.encoding.EncodingFactory
Gets a new ArabicEncoder instance for the specified encoding scheme.
getErrorCount() - Static method in class org.jqurantree.core.error.Errors
Gets the total number of error messages.
getInteger(int, int) - Method in class org.jqurantree.analysis.AnalysisTable
Converts the value of a cell to an int, given the cell's row index and column index.
getInteger(int, String) - Method in class org.jqurantree.analysis.AnalysisTable
Converts the value of a cell to an int, given the cell's row index and column name.
getItem(char) - Method in class org.jqurantree.arabic.encoding.EncodingTableBase
Gets an item in the table by Unicode character.
getLength() - Method in class org.jqurantree.arabic.ArabicText
Gets the number of characters in the text.
getLetterCount() - Method in class org.jqurantree.arabic.ArabicText
Gets the number of Arabic letters, which is the number of ArabicCharacters excluding any Quranic symbols.
getLocation() - Method in class org.jqurantree.orthography.Chapter
Gets the chapter's location.
getLocation() - Method in class org.jqurantree.orthography.Token
Gets the token's location.
getLocation() - Method in class org.jqurantree.orthography.Verse
Gets the verse's location.
getName() - Method in class org.jqurantree.orthography.Chapter
Gets the name of the chapter as ArabicText.
getName() - Static method in class org.jqurantree.orthography.Document
Gets the name of the document.
getResults() - Method in class org.jqurantree.search.TokenSearch
Gets an AnalysisTable holding the search results.
getRowCount() - Method in class org.jqurantree.analysis.AnalysisTable
Gets the number of rows in the table.
getString(int, int) - Method in class org.jqurantree.analysis.AnalysisTable
Converts the value of a cell to a string, given the cell's row index and column index.
getString(int, String) - Method in class org.jqurantree.analysis.AnalysisTable
Converts the value of a cell to a string, given the cell's row index and column name.
getSubstring(int, int) - Method in class org.jqurantree.arabic.ArabicText
Gets a new ArabicText instance that is a substring of this instance.
getText(String) - Static method in class org.jqurantree.core.resource.ResourceUtil
Opens an embedded JAR resource, reads the entire content as text, then closes the resource.
getToken(int, int, int) - Static method in class org.jqurantree.orthography.Document
Gets a token in the document by chapter, verse and token number.
getToken(Location) - Static method in class org.jqurantree.orthography.Document
Gets a token in the document by Location reference.
getToken(Location) - Method in class org.jqurantree.orthography.Verse
Gets a token in the verse by Location reference.
getToken(int) - Method in class org.jqurantree.orthography.Verse
Gets a token in the verse by token number.
getTokenCount() - Method in class org.jqurantree.orthography.Chapter
Gets the number of tokens in the chapter.
getTokenCount() - Static method in class org.jqurantree.orthography.Document
Gets the number of tokens in the document.
getTokenCount() - Method in class org.jqurantree.orthography.Verse
Gets the number of tokens in the verse.
getTokenNumber() - Method in class org.jqurantree.orthography.Location
Gets the token number.
getTokenNumber() - Method in class org.jqurantree.orthography.Token
Gets the token number.
getTokens() - Static method in class org.jqurantree.orthography.Document
Gets an iterator used to enumerate over all tokens in the document.
getTokens() - Method in class org.jqurantree.orthography.Verse
Gets an iterator used to enumerate over all tokens in the verse.
getType() - Method in class org.jqurantree.arabic.ArabicCharacter
Gets the CharacterType of the character, such as Alif or Ba.
getValue(int, int) - Method in class org.jqurantree.analysis.AnalysisTable
Gets the value of a cell in the table, given the cell's row index and column index.
getValue(int, String) - Method in class org.jqurantree.analysis.AnalysisTable
Gets the value of a cell in the table, given the cell's row index and column name.
getVerse(int) - Method in class org.jqurantree.orthography.Chapter
Gets a verse in the chapter by verse number.
getVerse(Location) - Method in class org.jqurantree.orthography.Chapter
Gets a verse in the chapter by Location reference.
getVerse(int, int) - Static method in class org.jqurantree.orthography.Document
Gets a verse in the document by chapter and verse number.
getVerse(Location) - Static method in class org.jqurantree.orthography.Document
Gets a verse in the document by Location reference.
getVerse() - Method in class org.jqurantree.orthography.Token
Gets the verse that contains the token.
getVerseCount() - Method in class org.jqurantree.orthography.Chapter
Gets the number of verses in the chapter.
getVerseCount() - Static method in class org.jqurantree.orthography.Document
Gets the number of verses in the document.
getVerseNumber() - Method in class org.jqurantree.orthography.Location
Gets the verse number.
getVerseNumber() - Method in class org.jqurantree.orthography.Token
Gets the verse number.
getVerseNumber() - Method in class org.jqurantree.orthography.Verse
Gets the verse number.
getVerses() - Static method in class org.jqurantree.orthography.Document
Gets an iterator used to enumerate over all verses in the document.
group(String...) - Method in class org.jqurantree.analysis.AnalysisTable
Creates a new table by grouping this analysis table by the specified list of columns.

H

hasNext() - Method in class org.jqurantree.core.collections.ArrayIterator
 
hasNext() - Method in class org.jqurantree.core.collections.ImmutableIteratorBase
Returns true if the iteration has more elements.

I

IMMUTABLE_COLLECTION - Static variable in class org.jqurantree.core.error.Errors
"The collection is immutable and cannot be modified."
ImmutableIteratorBase<T> - Class in org.jqurantree.core.collections
ImmutableIteratorBase provides a common implementation for iterators that do not modify their underlying collection.
ImmutableIteratorBase() - Constructor for class org.jqurantree.core.collections.ImmutableIteratorBase
 
INVALID_CHAPTER_NUMBER - Static variable in class org.jqurantree.core.error.Errors
"Chapter numbers should be between 1 and 114 inclusive."
INVALID_COLUMN_NAME - Static variable in class org.jqurantree.core.error.Errors
"The specific column could not be found."
INVALID_ENCODING_TYPE - Static variable in class org.jqurantree.core.error.Errors
"The specified encoding type is not supported."
INVALID_TANZIL_XML - Static variable in class org.jqurantree.core.error.Errors
"Failed to read Tanzil XML."
INVALID_VERSE_NUMBER - Static variable in class org.jqurantree.core.error.Errors
"The verse number is out of range."
isAlifKhanjareeya() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if Alif Khanjareeya is attached.
isAlifKhanjareeya(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if Alif Khanjareeya is attached.
isDamma() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if a Damma is attached.
isDamma(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if a Damma is present.
isDammatan() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if Dammatan are attached.
isDammatan(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if Dammatan are present.
isDiacritic(byte[], int, DiacriticType) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if a diacritic is present.
isFatha() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if a Fatha is attached.
isFatha(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if a Fatha is present.
isFathatan() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if Fathatan are attached.
isFathatan(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if Fathatan are present.
isHamzaAbove() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if a Hamza is present above the character.
isHamzaAbove(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if a Hamza is present above the character.
isHamzaBelow() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if a Hamza is present below the character.
isHamzaBelow(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if a Hamza is present below the character.
isHamzatWasl() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if Hamzat Wasl is attached.
isHamzatWasl(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if Hamzat Wasl is attached.
isKasra() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if a Kasra is attached.
isKasra(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if a Kasra is present.
isKasratan() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if Kasratan are attached.
isKasratan(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if Kasratan are present.
isLetter() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if the character is an Arabic letter.
isLetter(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if the character is an Arabic letter.
isMaddah() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if a Maddah is attached.
isMaddah(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if a Maddah is present.
isShadda() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if a Shadda is attached.
isShadda(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if a Shadda is present.
isSingleDiacritic(DiacriticType) - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if only a single diacritic is attached.
isSingleDiacritic(byte[], int, DiacriticType) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if only a single diacritic is attached.
isSukun() - Method in class org.jqurantree.arabic.ArabicCharacter
Determines if a Sukun is attached.
isSukun(byte[], int) - Static method in class org.jqurantree.arabic.ByteFormat
Determines if a Sukun is present.
iterator() - Method in class org.jqurantree.analysis.AnalysisTable
Returns an iterator used to enumerate through all rows in the table.
iterator() - Method in class org.jqurantree.arabic.ArabicText
Gets an iterator which may be used to enumerate through each character in the text.
iterator() - Method in class org.jqurantree.core.collections.ArrayIterator
Returns the iterator.
iterator() - Method in class org.jqurantree.orthography.Chapter
Gets an iterator used to enumerate over all verses in the chapter.

J

JQuranTreeException - Exception in org.jqurantree.core.error
A JQuranTreeException is thrown by the API when an error occurs.
JQuranTreeException(String) - Constructor for exception org.jqurantree.core.error.JQuranTreeException
Creates a new JQuranTreeException with the specified error message.
JQuranTreeException(String, Exception) - Constructor for exception org.jqurantree.core.error.JQuranTreeException
Creates a new JQuranTreeException with an error message and an exception indicating the cause of the error

L

Location - Class in org.jqurantree.orthography
The location of an element in the orthography model, consisting of a chapter number, verse number and token number.
Location(int) - Constructor for class org.jqurantree.orthography.Location
Creates a new location which references a chapter.
Location(int, int) - Constructor for class org.jqurantree.orthography.Location
Creates a new location which references a verse within a chapter.
Location(int, int, int) - Constructor for class org.jqurantree.orthography.Location
Creates a new location which references a token within a verse.

N

next() - Method in class org.jqurantree.core.collections.ArrayIterator
 
next() - Method in class org.jqurantree.core.collections.ImmutableIteratorBase
Returns the next element in the iteration.

O

offset - Variable in class org.jqurantree.arabic.ArabicText
The offset to the first character in the buffer.
open(String) - Static method in class org.jqurantree.core.resource.ResourceUtil
Opens an embedded JAR resource for reading.
org.jqurantree.analysis - package org.jqurantree.analysis
Contains the AnalysisTable class, which is used to tabulate, sort and group results.
org.jqurantree.arabic - package org.jqurantree.arabic
Models ArabicText as a sequence of characters with diacritics, with an internal ByteFormat used to represent character data.
org.jqurantree.arabic.encoding - package org.jqurantree.arabic.encoding
Contains interfaces and supporting base classes for Arabic encoders and decoders.
org.jqurantree.arabic.encoding.buckwalter - package org.jqurantree.arabic.encoding.buckwalter
Contains the BuckwalterEncoder and BuckwalterDecoder classes, which implement Buckwalter transliteration.
org.jqurantree.arabic.encoding.simple - package org.jqurantree.arabic.encoding.simple
Contains the SimpleEncoder class which implements simple encoding.
org.jqurantree.arabic.encoding.unicode - package org.jqurantree.arabic.encoding.unicode
Contains the UnicodeEncoder and UnicodeDecoder classes for translating ArabicText to and from Unicode.
org.jqurantree.core.collections - package org.jqurantree.core.collections
Support package which provides generic iterators for enumerating over immutable collections.
org.jqurantree.core.error - package org.jqurantree.core.error
Contains the JQuranTreeException class and a list of Errors.
org.jqurantree.core.io - package org.jqurantree.core.io
Supporting package which provides classes for I/O file access.
org.jqurantree.core.resource - package org.jqurantree.core.resource
Supporting package for accessing embedded JAR resources.
org.jqurantree.orthography - package org.jqurantree.orthography
Contains an orthography object model of the Holy Quran, with orthographic elements represented by the classes Document, Chapter, Verse and Token.
org.jqurantree.search - package org.jqurantree.search
Search API package, providing classes for searching the Holy Quran.
org.jqurantree.tanzil - package org.jqurantree.tanzil
Provides classes for reading the Unicode XML source of the orthography model, the Tanzil project's Uthmani distribution.

R

readLine() - Method in class org.jqurantree.core.resource.ResourceReader
Reads a line of text from the resource.
readXml() - Method in class org.jqurantree.tanzil.TanzilReader
Loads the orthography model.
readXml(String) - Method in class org.jqurantree.tanzil.TanzilReader
Loads the orthography model, from the specified embedded JAR resource.
remove() - Method in class org.jqurantree.core.collections.ImmutableIteratorBase
Always throws an UnsupportedOperationException, since the underlying collection is immutable
removeDiacritics() - Method in class org.jqurantree.arabic.ArabicText
Gets a new ArabicText instance that is a copy of this instance excluding any attached diacritics.
removeNonLetters() - Method in class org.jqurantree.arabic.ArabicText
Gets a new ArabicText instance that is a copy of this instance excluding any Quranic symbols.
RESOURCE_CLOSE_FAILED - Static variable in class org.jqurantree.core.error.Errors
"Failed to close embedded JAR resource."
RESOURCE_NOT_FOUND - Static variable in class org.jqurantree.core.error.Errors
"The embedded JAR resource could not be found."
RESOURCE_READ_FAILED - Static variable in class org.jqurantree.core.error.Errors
"Failed to read embedded JAR resource."
ResourceReader - Class in org.jqurantree.core.resource
Utility class which supports reading lines of text from an embedded JAR resource.
ResourceReader(String) - Constructor for class org.jqurantree.core.resource.ResourceReader
Creates a new resource reader.
ResourceUtil - Class in org.jqurantree.core.resource
Utiltiy class which provides convenience methods for accessing embedded JAR resources.

S

SearchOptions - Enum in org.jqurantree.search
The SearchOptions enumeration specifies which options to use when performing searches.
setDiacritic(byte[], int, DiacriticType) - Static method in class org.jqurantree.arabic.ByteFormat
Sets a diacritic as present.
SimpleEncoder - Class in org.jqurantree.arabic.encoding.simple
Supports encoding ArabicText into simple encoding.
SimpleEncoder() - Constructor for class org.jqurantree.arabic.encoding.simple.SimpleEncoder
Creates a new simple encoder.
sort(String) - Method in class org.jqurantree.analysis.AnalysisTable
Sorts all rows in ascending order, by the specified column.
sort(String, SortOrder) - Method in class org.jqurantree.analysis.AnalysisTable
Sorts all rows by a column, in the specified sort order.
SortOrder - Enum in org.jqurantree.analysis
The SortOrder enumeration specifies whether to sort the rows of an AnalysisTable in ascending or descending order.

T

TANZIL_RESOURCE_PATH - Static variable in class org.jqurantree.tanzil.TanzilReader
The path to the Tanzil XML document, as an embedded JAR resource.
TanzilReader - Class in org.jqurantree.tanzil
Used internally to initiate the orthography model by reading the embedded Tanzil XML JAR resource.
TanzilReader() - Constructor for class org.jqurantree.tanzil.TanzilReader
 
text - Variable in class org.jqurantree.arabic.encoding.ArabicEncoderBase
A string buffer used to hold the encoder's plain text output.
toBuckwalter() - Method in class org.jqurantree.arabic.ArabicCharacter
Converts the character to a string using Buckwalter transliteration.
toBuckwalter() - Method in class org.jqurantree.arabic.ArabicText
Converts the Arabic text to Buckwalter transliteration.
toByteArray() - Method in class org.jqurantree.arabic.ArabicTextBuilder
Gets a copy of the internal byte[] buffer holding only used characters.
Token - Class in org.jqurantree.orthography
An orthographic token is whitespace-delimited ArabicText within a verse.
TokenSearch - Class in org.jqurantree.search
The TokenSearch class searches for tokens within the orthography model.
TokenSearch(EncodingType) - Constructor for class org.jqurantree.search.TokenSearch
Creates a new TokenSearch instance, using the specified encoding scheme.
TokenSearch(EncodingType, SearchOptions) - Constructor for class org.jqurantree.search.TokenSearch
Creates a new TokenSearch instance, using the specified encoding scheme and search options.
toSimpleEncoding() - Method in class org.jqurantree.arabic.ArabicCharacter
Converts the character to a string using simple encoding.
toSimpleEncoding() - Method in class org.jqurantree.arabic.ArabicText
Converts the Arabic text to simple encoding.
toString() - Method in class org.jqurantree.analysis.AnalysisTable
Converts the analysis table to a string.
toString(int) - Method in class org.jqurantree.analysis.AnalysisTable
Converts the top rows of the analysis table to a string.
toString() - Method in class org.jqurantree.arabic.ArabicCharacter
Converts the character to a string using the default encoding scheme.
toString(EncodingType) - Method in class org.jqurantree.arabic.ArabicCharacter
Converts the character to a string using the specified encoding type.
toString() - Method in class org.jqurantree.arabic.ArabicText
Converts the Arabic text to Unicode.
toString(EncodingType) - Method in class org.jqurantree.arabic.ArabicText
Converts the Arabic text to a string according the specified encoding scheme.
toString(EncodingType, EncodingOptions) - Method in class org.jqurantree.arabic.ArabicText
Converts the Arabic text to a string according the specified encoding scheme and encoding options.
toString() - Method in class org.jqurantree.arabic.ArabicTextBuilder
Converts the Arabic text builder to a string.
toString() - Method in class org.jqurantree.orthography.Chapter
Gets a string representation of the chapter's location, for example "Chapter 18".
toString() - Method in class org.jqurantree.orthography.Location
Gets a string representation of the location.
toString() - Method in class org.jqurantree.orthography.Verse
Converts the verse to a string.
toText() - Method in class org.jqurantree.arabic.ArabicTextBuilder
Creates a new ArabicText instance from the characters in the buffer.
toUnicode() - Method in class org.jqurantree.arabic.ArabicCharacter
Converts the character to Unicode.
toUnicode() - Method in class org.jqurantree.arabic.ArabicText
Converts the Arabic text to Unicode.

U

UnicodeDecoder - Class in org.jqurantree.arabic.encoding.unicode
Supports decoding Unicode character data into ArabicText.
UnicodeDecoder() - Constructor for class org.jqurantree.arabic.encoding.unicode.UnicodeDecoder
Creates a new Unicode decoder instance.
UnicodeEncoder - Class in org.jqurantree.arabic.encoding.unicode
Supports encoding ArabicText into Unicode character data.
UnicodeEncoder() - Constructor for class org.jqurantree.arabic.encoding.unicode.UnicodeEncoder
Creates a new Unicode encoder.
UnicodeType - Enum in org.jqurantree.arabic.encoding.unicode
The UnicodeType enumeration specifies the type of a Unicode character, and is used internally by ArabicText encoders and decoders.

V

valueOf(String) - Static method in enum org.jqurantree.analysis.SortOrder
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jqurantree.arabic.CharacterType
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum org.jqurantree.arabic.CharacterType
Gets a character type given its ordinal value.
valueOf(String) - Static method in enum org.jqurantree.arabic.DiacriticType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jqurantree.arabic.encoding.EncodingOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jqurantree.arabic.encoding.EncodingType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jqurantree.arabic.encoding.unicode.UnicodeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jqurantree.search.SearchOptions
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jqurantree.analysis.SortOrder
Returns an array containing the constants of this enum type, in the order they are declared.
values - Static variable in enum org.jqurantree.arabic.CharacterType
An ordered array of character types.
values() - Static method in enum org.jqurantree.arabic.CharacterType
Returns an array containing the constants of this enum type, in the order they are declared.
values - Static variable in enum org.jqurantree.arabic.DiacriticType
An ordered array of diacritic types.
values() - Static method in enum org.jqurantree.arabic.DiacriticType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jqurantree.arabic.encoding.EncodingOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jqurantree.arabic.encoding.EncodingType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jqurantree.arabic.encoding.unicode.UnicodeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jqurantree.search.SearchOptions
Returns an array containing the constants of this enum type, in the order they are declared.
Verse - Class in org.jqurantree.orthography
The verse class represents one of the numbered verses in a chapter.
Verse(int, int, String) - Constructor for class org.jqurantree.orthography.Verse
Creates a new verse, used by JQuranTree when constructing the orthography model.

W

WHITESPACE - Static variable in class org.jqurantree.arabic.ByteFormat
The buffer byte value representing a space delimiter.
write(char) - Method in class org.jqurantree.core.io.FileWriter
Writes a character to the file.
write(String) - Method in class org.jqurantree.core.io.FileWriter
Writes a string to the file
writeCharacterSeperator() - Method in class org.jqurantree.arabic.encoding.ArabicEncoderBase
Overriden by derived encoders to write a seperator between each ArabicCharacter.
writeCharacterSeperator() - Method in class org.jqurantree.arabic.encoding.simple.SimpleEncoder
 
writeFile(String) - Method in class org.jqurantree.analysis.AnalysisTable
Saves the contents of the analysis table to disk, by writing out a delimited file.
writeFile(String, char) - Method in class org.jqurantree.analysis.AnalysisTable
Saves the contents of the analysis table to disk, by writing out a delimited file.
writeFile(String, char, int) - Method in class org.jqurantree.analysis.AnalysisTable
Saves the top rows of the analysis table to disk, by writing out a delimited file.
writeLine() - Method in class org.jqurantree.core.io.FileWriter
Writes a line break to the file.
writeLine(String) - Method in class org.jqurantree.core.io.FileWriter
Writes a new line of text to the file.

A B C D E F G H I J L N O R S T U V W

Copyright© Kais Dukes, 2009. All Rights Reserved.