public static interface

IncrementalFetch.IncrementalFetchDetails

com.microstrategy.web.app.gui.IncrementalFetch.IncrementalFetchDetails

Class Overview

This class takes care of the calculations needed for knowing what element indexes are currently being displayed, how many total elements are on the list, how many are still ahead, etc.

Summary

Public Methods
abstract int getBlockBegin()
abstract int getBlockCount()
abstract int getCurrentEndIndex()
abstract int getCurrentStartIndex()
abstract int getFetchSize()
abstract int getListStartIndex()
abstract int getNextIndex()
abstract int getNextSetIndex()
abstract int getPageCount()
abstract int getPageNumber(int elementIndex)
Helper method for obtaining the page number index corresponding to the information provided
abstract int getPreviousIndex()
abstract int getPreviousSetIndex()
abstract int getRemaining()
abstract int getTotalCount()

Public Methods

public abstract int getBlockBegin ()

Returns
  • the value where the current block begins

public abstract int getBlockCount ()

Returns
  • the value of the block's size

public abstract int getCurrentEndIndex ()

Returns
  • the element index where the current list being viewed ends

public abstract int getCurrentStartIndex ()

Returns
  • the element index where the current list being viewed starts

public abstract int getFetchSize ()

Returns
  • the fetch size, which is the increments to be handled on the next and previous buttons in case navigation mode is specified as multiple

public abstract int getListStartIndex ()

Returns
  • the list start index value

public abstract int getNextIndex ()

Returns
  • the element index to access if the user decides to navigate to the next page

public abstract int getNextSetIndex ()

Returns
  • the element index to access if the user decides to navigate to the next set page index

public abstract int getPageCount ()

Returns
  • the total number of pages available

public abstract int getPageNumber (int elementIndex)

Helper method for obtaining the page number index corresponding to the information provided

Parameters
elementIndex index of the element on the page
Returns
  • the page number index corresponding to the information provided and the definition of this instance in terms of block size and list start index.

public abstract int getPreviousIndex ()

Returns
  • the element index to access if the user decides to navigate to the previous page

public abstract int getPreviousSetIndex ()

Returns
  • the element index to access if the user decides to navigate to the previous set page index

public abstract int getRemaining ()

Returns
  • the number of elements on the list, ahead of the current ones being viewed

public abstract int getTotalCount ()

Returns
  • the total number of elements on the list