net.sf.zekr.engine.search
Class SearchScope

java.lang.Object
  extended by net.sf.zekr.engine.search.SearchScope

public class SearchScope
extends java.lang.Object


Constructor Summary
SearchScope()
           
 
Method Summary
 void add(SearchScopeItem item)
           
 boolean contains(SearchScopeItem item)
           
 boolean equals(java.lang.Object obj)
           
 java.util.List getScopeItems()
           
 boolean includes(int sura, int aya)
          Tests whether an aya of a sura conforms to the search scope constraints.
 boolean includes(IQuranLocation quranLocation)
          Tests whether an aya of a sura conforms to the search scope constraints.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SearchScope

public SearchScope()
Method Detail

add

public void add(SearchScopeItem item)

contains

public boolean contains(SearchScopeItem item)

getScopeItems

public java.util.List getScopeItems()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

includes

public boolean includes(IQuranLocation quranLocation)
Tests whether an aya of a sura conforms to the search scope constraints.

Parameters:
quranLocation - the sura-aya pair.
Returns:
true if this search scope includes the aya (constraints are applied consecutively), false otherwise.

includes

public boolean includes(int sura,
                        int aya)
Tests whether an aya of a sura conforms to the search scope constraints.

Parameters:
sura - sura number
aya - aya number
Returns:
true if this search scope includes the aya (constraints are applied consecutively), false otherwise.