/*
* Copyright � 2016 TIBCO Software,Inc.All rights reserved.
* http://community.jaspersoft.com/project/jaspermobile-android
*
* Unless you have purchased a commercial license agreement from TIBCO Jaspersoft,
* the following license terms apply:
*
* This program is part of TIBCO Jaspersoft Mobile for Android.
*
* TIBCO Jaspersoft Mobile is free software:you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation,either version 3of the License,or
* (at your option)any later version.
*
* TIBCO Jaspersoft Mobile is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY;without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with TIBCO Jaspersoft Mobile for Android.If not,see
* <http://www.gnu.org/licenses/lgpl>.
*/
package com.jaspersoft.android.jaspermobile.domain.interactor;
import com.jaspersoft.android.jaspermobile.domain.executor.PostExecutionThread;
import com.jaspersoft.android.jaspermobile.domain.executor.PreExecutionThread;
import rx.Observable;
import rx.Subscriber;
import rx.Subscription;
import rx.subscriptions.Subscriptions;
/**
* Abstract class for a Use Case (Interactor in terms of Clean Architecture).
* This interface represents a execution unit for different use cases (this means any use case
* in the application should implement this contract).
* <p/>
* By convention each UseCase implementation will return the result using a {@link rx.Subscriber}
* that will execute its job in a background thread and will post the result in the UI thread.
*/
public abstract class AbstractSimpleUseCase<Result> implements SimpleUseCase<Result> {
private Subscription subscription = Subscriptions.empty();
/**
* Builds an {@link rx.Observable} which will be used when executing the current {@link AbstractSimpleUseCase}.
*/
protected abstract Observable<Result> buildUseCaseObservable();
private final PreExecutionThread mPreExecutionThread;
private final PostExecutionThread mPostExecutionThread;
protected AbstractSimpleUseCase(PreExecutionThread preExecutionThread, PostExecutionThread postExecutionThread) {
mPreExecutionThread = preExecutionThread;
mPostExecutionThread = postExecutionThread;
}
/**
* Executes the current use case.
*
* @param useCaseSubscriber The guy who will be listen to the observable build with {@link #buildUseCaseObservable()}.
*/
@Override
public void execute(Subscriber<? super Result> useCaseSubscriber) {
this.subscription = this.buildUseCaseObservable()
.subscribeOn(mPreExecutionThread.getScheduler())
.observeOn(mPostExecutionThread.getScheduler())
.subscribe(useCaseSubscriber);
}
/**
* Unsubscribes from current {@link rx.Subscription}.
*/
@Override
public void unsubscribe() {
if (!subscription.isUnsubscribed()) {
subscription.unsubscribe();
}
}
}