Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jdesktop.swingx.ws.yahoo.search
[Java] Class PagedResultsArrayList

java.lang.Object
  org.jdesktop.beans.AbstractBean
      org.jdesktop.swingx.ws.yahoo.search.PagedResultsArrayList
All Implemented Interfaces:
List, PagedResultsList
public class PagedResultsArrayList
extends org.jdesktop.beans.AbstractBean

A non visual JavaBean that represents the results of a Yahoo! search. Unlike ResultsList which only contains the results of a single "page" of search results, PagedResultsArrayList allows you to step through all of the results returned from a search.

Sample usage: 


      YahooWebSearch yahoo = new YahooWebSearch();
      yahoo.appId = "myappidxxx(get one from yahoo)";
      yahoo.query = "world cup 2006 Italy";
      PagedResultsArrayList results = new
              PagedResultsArrayList();
      results.setYahooSearch(yahoo);
      results.refresh();
      
      System.out.println("NumPages: " + results.getNumPages());
      System.out.println("NumResults: " + results.getTotalResultsAvailable());
      
      int count = 1;
      while (count < 300 && results.hasNextPage()) {
          for (int i=0; i

Authors:
rbair

Field Summary
private int currentPageIndex

The index of the current page loaded in this list
private int firstResultPosition

private int numPages

The number of logical pages in this List
private List results

Implementation detail: stores the results of the search
private int resultsPerPage

The number of results per page.

private int totalResultsAvailable

private YahooSearch yahoo

The YahooSearch component that will perform the searches
 
Constructor Summary
PagedResultsArrayList()

Creates a new instance of PagedResultsArrayList
 
Method Summary
boolean add(E e)

void add(int index, E element)

boolean addAll(Collection c)

boolean addAll(int index, Collection c)

void clear()

boolean contains(Object o)

boolean containsAll(Collection c)

boolean equals(Object o)

boolean firstPage()

@inheritDoc
E get(int index)

int getCurrentPageIndex()

int getFirstResultPosition()

int getNumPages()

@inheritDoc
int getResultsPerPage()

int getTotalResultsAvailable()

YahooSearch getYahooSearch()

boolean gotoPage(int index)

@inheritDoc
int hashCode()

int indexOf(Object o)

boolean isEmpty()

boolean isHasNextPage()

@inheritDoc
boolean isHasPreviousPage()

@inheritDoc
Iterator iterator()

int lastIndexOf(Object o)

boolean lastPage()

@inheritDoc
ListIterator listIterator()

ListIterator listIterator(int index)

boolean nextPage()

@inheritDoc
boolean previousPage()

@inheritDoc
void refresh()

boolean remove(Object o)

E remove(int index)

boolean removeAll(Collection c)

boolean retainAll(Collection c)

E set(int index, E element)

void setResultsPerPage(int value)

void setYahooSearch(YahooSearch search)

int size()

List subList(int fromIndex, int toIndex)

Object[] toArray()

Object[] toArray(Object[] a)

 
Methods inherited from class org.jdesktop.beans.AbstractBean
org.jdesktop.beans.AbstractBean#clone(), org.jdesktop.beans.AbstractBean#addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#addPropertyChangeListener(java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#removePropertyChangeListener(java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#getPropertyChangeListeners(java.lang.String), org.jdesktop.beans.AbstractBean#getPropertyChangeListeners(), org.jdesktop.beans.AbstractBean#addVetoableChangeListener(java.lang.String, java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#addVetoableChangeListener(java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#removeVetoableChangeListener(java.lang.String, java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#removeVetoableChangeListener(java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#getVetoableChangeListeners(java.lang.String), org.jdesktop.beans.AbstractBean#getVetoableChangeListeners(), org.jdesktop.beans.AbstractBean#wait(), org.jdesktop.beans.AbstractBean#wait(long), org.jdesktop.beans.AbstractBean#wait(long, int), org.jdesktop.beans.AbstractBean#equals(java.lang.Object), org.jdesktop.beans.AbstractBean#toString(), org.jdesktop.beans.AbstractBean#hashCode(), org.jdesktop.beans.AbstractBean#getClass(), org.jdesktop.beans.AbstractBean#notify(), org.jdesktop.beans.AbstractBean#notifyAll()
 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

currentPageIndex

private int currentPageIndex
The index of the current page loaded in this list

firstResultPosition

private int firstResultPosition

numPages

private int numPages
The number of logical pages in this List

results

private List results
Implementation detail: stores the results of the search

resultsPerPage

private int resultsPerPage
The number of results per page. When this changes, the numPages value also changes since numPages is calculated based on the number of search results / resultsPerPage. The currentPageIndex may also change in that scenario.

totalResultsAvailable

private int totalResultsAvailable

yahoo

private YahooSearch yahoo
The YahooSearch component that will perform the searches

 
Constructor Detail

PagedResultsArrayList

public PagedResultsArrayList()
Creates a new instance of PagedResultsArrayList

 
Method Detail

add

public boolean add(E e)

add

public void add(int index, E element)

addAll

public boolean addAll(Collection c)

addAll

public boolean addAll(int index, Collection c)

clear

public void clear()

contains

public boolean contains(Object o)

containsAll

public boolean containsAll(Collection c)

equals

public boolean equals(Object o)

firstPage

public boolean firstPage()
inheritDoc:

get

public E get(int index)

getCurrentPageIndex

public final int getCurrentPageIndex()

getFirstResultPosition

public final int getFirstResultPosition()

getNumPages

public int getNumPages()
inheritDoc:

getResultsPerPage

public final int getResultsPerPage()

getTotalResultsAvailable

public final int getTotalResultsAvailable()

getYahooSearch

public final YahooSearch getYahooSearch()

gotoPage

public boolean gotoPage(int index)
inheritDoc:

hashCode

public int hashCode()

indexOf

public int indexOf(Object o)

isEmpty

public boolean isEmpty()

isHasNextPage

public boolean isHasNextPage()
inheritDoc:

isHasPreviousPage

public boolean isHasPreviousPage()
inheritDoc:

iterator

public Iterator iterator()

lastIndexOf

public int lastIndexOf(Object o)

lastPage

public boolean lastPage()
inheritDoc:

listIterator

public ListIterator listIterator()

listIterator

public ListIterator listIterator(int index)

nextPage

public boolean nextPage()
inheritDoc:

previousPage

public boolean previousPage()
inheritDoc:

refresh

public void refresh()

remove

public boolean remove(Object o)

remove

public E remove(int index)

removeAll

public boolean removeAll(Collection c)

retainAll

public boolean retainAll(Collection c)

set

public E set(int index, E element)

setResultsPerPage

public final void setResultsPerPage(int value)

setYahooSearch

public final void setYahooSearch(YahooSearch search)

size

public int size()

subList

public List subList(int fromIndex, int toIndex)

toArray

public Object[] toArray()

toArray

public Object[] toArray(Object[] a)

 

Groovy Documentation