io.reactivesprint.viewmodels

Class FetchedArrayViewModel<E extends IViewModel,P>

java.lang.Object

io.reactivesprint.viewmodels.ViewModel

io.reactivesprint.viewmodels.FetchedArrayViewModel<E,P>

All Implemented Interfaces:

IArrayViewModel<E>, IFetchedArrayViewModel<E,P,java.lang.Void,java.util.Collection<E>>, IViewModel, java.lang.Iterable<E>, java.util.RandomAccess

public abstract class FetchedArrayViewModel<E extends IViewModel,P>
extends ViewModel
implements IFetchedArrayViewModel<E,P,java.lang.Void,java.util.Collection<E>>, java.util.RandomAccess

Created by Ahmad Baraka on 4/2/16. An implementation of IFetchedArrayViewModel that fetches ViewModels by calling onFetch(Object)

Constructor Summary

Constructors

Constructor and Description
FetchedArrayViewModel()

Method Summary

Methods

Modifier and Type	Method and Description
protected ICommand<java.lang.Void,java.util.Collection<E>>	createFetchCommand()
protected ICommand<java.lang.Void,java.util.Collection<E>>	createFetchIfNeededCommand()
protected ICommand<java.lang.Void,java.util.Collection<E>>	createRefreshCommand()
IProperty<java.lang.Integer>	getCount()
ICommand<java.lang.Void,java.util.Collection<E>>	getFetchCommand()
ICommand<java.lang.Void,java.util.Collection<E>>	getFetchIfNeededCommand()
IMutableProperty<java.lang.CharSequence>	getLocalizedEmptyMessage()
P	getNextPage()
ICommand<java.lang.Void,java.util.Collection<E>>	getRefreshCommand()
E	getViewModel(int index) Access the indexth element.
java.util.List<E>	getViewModels()
IProperty<java.lang.Boolean>	hasNextPage()
int	indexOf(E element)
IProperty<java.lang.Boolean>	isEmpty()
IProperty<java.lang.Boolean>	isFetchingNextPage()
IProperty<java.lang.Boolean>	isRefreshing()
java.util.Iterator<E>	iterator()
protected abstract rx.Observable<Pair<P,java.util.Collection<E>>>	onFetch(P page) Implement this method to fetch ViewModels at page
protected void	setNextPage(P nextPage)
protected void	setViewModels(java.util.Collection<E> viewModels)

Methods inherited from class io.reactivesprint.viewmodels.ViewModel

bindCommand, bindErrors, bindLoading, getActive, getErrors, getTitle, isEnabled, isLoading

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.reactivesprint.viewmodels.IViewModel

bindCommand, bindErrors, bindLoading, getActive, getErrors, getTitle, isEnabled, isLoading

Constructor Detail

FetchedArrayViewModel

public FetchedArrayViewModel()

Method Detail

onFetch

protected abstract rx.Observable<Pair<P,java.util.Collection<E>>> onFetch(P page)

Implement this method to fetch ViewModels at page

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E extends IViewModel>

getCount

public IProperty<java.lang.Integer> getCount()

Specified by:

getCount in interface IArrayViewModel<E extends IViewModel>

Returns:

Count of wrapped elements.

isEmpty

public IProperty<java.lang.Boolean> isEmpty()

Specified by:

isEmpty in interface IArrayViewModel<E extends IViewModel>

Returns:

true if Array is empty, false otherwise.

getLocalizedEmptyMessage

public IMutableProperty<java.lang.CharSequence> getLocalizedEmptyMessage()

Specified by:

getLocalizedEmptyMessage in interface IArrayViewModel<E extends IViewModel>

Returns:

localized message to be used when the array is empty.

getViewModels

public java.util.List<E> getViewModels()

Specified by:

getViewModels in interface IArrayViewModel<E extends IViewModel>

Returns:

List of Element

setViewModels

protected void setViewModels(java.util.Collection<E> viewModels)

indexOf

public int indexOf(E element)

Specified by:

indexOf in interface IArrayViewModel<E extends IViewModel>

Returns:

the first index where value equals element or null element is not found.

getViewModel

public E getViewModel(int index)

Description copied from interface: IArrayViewModel

Access the indexth element.

Specified by:

getViewModel in interface IArrayViewModel<E extends IViewModel>

Parameters:

index - Must be > 0 and < count.

isRefreshing

public IProperty<java.lang.Boolean> isRefreshing()

Specified by:

isRefreshing in interface IFetchedArrayViewModel<E extends IViewModel,P,java.lang.Void,java.util.Collection<E extends IViewModel>>

Returns:

Whether the receiver is refreshing.

getNextPage

public P getNextPage()

Specified by:

getNextPage in interface IFetchedArrayViewModel<E extends IViewModel,P,java.lang.Void,java.util.Collection<E extends IViewModel>>

Returns:

An object representing next page.

setNextPage

protected void setNextPage(P nextPage)

isFetchingNextPage

public IProperty<java.lang.Boolean> isFetchingNextPage()

Specified by:

isFetchingNextPage in interface IFetchedArrayViewModel<E extends IViewModel,P,java.lang.Void,java.util.Collection<E extends IViewModel>>

Returns:

Whether the receiver is fetching next page.

hasNextPage

public IProperty<java.lang.Boolean> hasNextPage()

Specified by:

hasNextPage in interface IFetchedArrayViewModel<E extends IViewModel,P,java.lang.Void,java.util.Collection<E extends IViewModel>>

Returns:

Next Page

getRefreshCommand

public ICommand<java.lang.Void,java.util.Collection<E>> getRefreshCommand()

Specified by:

getRefreshCommand in interface IFetchedArrayViewModel<E extends IViewModel,P,java.lang.Void,java.util.Collection<E extends IViewModel>>

Returns:

Command which refreshes ViewModels.

getFetchCommand

public ICommand<java.lang.Void,java.util.Collection<E>> getFetchCommand()

Specified by:

getFetchCommand in interface IFetchedArrayViewModel<E extends IViewModel,P,java.lang.Void,java.util.Collection<E extends IViewModel>>

Returns:

Command which fetches ViewModels. If nextPage is null, this command will refresh, else this command should fetch next page.

getFetchIfNeededCommand

public ICommand<java.lang.Void,java.util.Collection<E>> getFetchIfNeededCommand()

Specified by:

getFetchIfNeededCommand in interface IFetchedArrayViewModel<E extends IViewModel,P,java.lang.Void,java.util.Collection<E extends IViewModel>>

Returns:

Applies IFetchedArrayViewModel.getFetchCommand() only if next page is non null or returns Observable.empty()

createRefreshCommand

protected ICommand<java.lang.Void,java.util.Collection<E>> createRefreshCommand()

createFetchCommand

protected ICommand<java.lang.Void,java.util.Collection<E>> createFetchCommand()

createFetchIfNeededCommand

protected ICommand<java.lang.Void,java.util.Collection<E>> createFetchIfNeededCommand()