Token (JQuranTree API Documentation)

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.jqurantree.orthography
Class Token

java.lang.Object
  org.jqurantree.arabic.ArabicText
      org.jqurantree.orthography.Token

All Implemented Interfaces:: java.lang.Iterable<ArabicCharacter>

public class Token
extends ArabicText
extends ArabicText

An orthographic token is whitespace-delimited ArabicText within a verse. This is typically a word with its affixes. In Arabic, a word and multiple particles may be fused together into a single orthographic token.

Author:: Kais Dukes

Field Summary

Fields inherited from class org.jqurantree.arabic.ArabicText
`buffer, characterCount, offset`

Method Summary
`Chapter`	`getChapter()` Gets the chapter that contains the token.
`int`	`getChapterNumber()` Gets the chapter number.
`Location`	`getLocation()` Gets the token's location.
`int`	`getTokenNumber()` Gets the token number.
`Verse`	`getVerse()` Gets the verse that contains the token.
`int`	`getVerseNumber()` Gets the verse number.

Methods inherited from class org.jqurantree.arabic.ArabicText
`fromBuckwalter, fromEncoding, fromUnicode, getCharacter, getCharacterType, getLength, getLetterCount, getSubstring, iterator, removeDiacritics, removeNonLetters, toBuckwalter, toSimpleEncoding, toString, toString, toString, toUnicode`

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

Method Detail

getLocation

public Location getLocation()

Gets the token's location.

Returns:: a location referencing the token

getChapterNumber

public int getChapterNumber()

Gets the chapter number.

Returns:: the chapter number, between 1 and 114 inclusive

getVerseNumber

public int getVerseNumber()

Gets the verse number.

Returns:: the verse number, a positive integer

getTokenNumber

public int getTokenNumber()

Gets the token number.

Returns:: the token number, a positive integer

getVerse

public Verse getVerse()

Gets the verse that contains the token.

Returns:: the token's verse

getChapter

public Chapter getChapter()

Gets the chapter that contains the token.

Returns:: the token's chapter