com.yahoo.bard.webservice.async.jobs.stores

Class NoOpApiJobStore

java.lang.Object

com.yahoo.bard.webservice.async.jobs.stores.NoOpApiJobStore

All Implemented Interfaces:

ApiJobStore

@Singleton
public class NoOpApiJobStore
extends Object
implements ApiJobStore

An ApiJobStore that doesn't actually do anything. Used as a default binding implementation for the ApiJobStore, allowing users who have no interest in asynchronous requests to set up a Bard instance without having to setup any asynchronous infrastructure.

Constructor Summary

Constructors

Constructor and Description
NoOpApiJobStore()

Method Summary

Modifier and Type	Method and Description
rx.Observable<JobRow>	get(String id) Returns a cold Observable that emits 0 or 1 messages: the desired JobRow, or nothing if there is no JobRow with the specified id.
rx.Observable<JobRow>	getAllRows() A cold observable that emits a stream of JobRows until all JobRows have been retrieved from the store.
rx.Observable<JobRow>	getFilteredRows(Set<JobRowFilter> jobRowFilter) This method ignores the filters and returns an empty Observable.
rx.Observable<JobRow>	save(JobRow metadata) Returns a cold Observable that emits the JobRow that has been stored.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoOpApiJobStore

public NoOpApiJobStore()

Method Detail

get

public rx.Observable<JobRow> get(String id)

Description copied from interface: ApiJobStore

Returns a cold Observable that emits 0 or 1 messages: the desired JobRow, or nothing if there is no JobRow with the specified id.

If an error is encountered while interacting with the metadata store, then the Observable's onError is called with the exception as payload.

Specified by:

get in interface ApiJobStore

Parameters:

id - The ID of the job desired

Returns:

An Observable that emits the metadata of the job with the specified id, if such a job exists

save

public rx.Observable<JobRow> save(JobRow metadata)

Description copied from interface: ApiJobStore

Returns a cold Observable that emits the JobRow that has been stored. The message is not emitted until the metadata has been successfully stored.

While the Observable should not emit a message until at least one subscriber has subscribed, it should store the results immediately, without waiting for a subscriber. If a row with the same ID already exists, then that row will be overwritten. Otherwise, a new ID-JobRow mapping is added to the store. If an error is encountered while storing the data, the Observable instead invokes the onError methods on its subscribers with an ApiJobStoreException

Specified by:

save in interface ApiJobStore

Parameters:

metadata - The Job metadata that needs to be stored

Returns:

An Observable that emits the JobRow that was just stored

getAllRows

public rx.Observable<JobRow> getAllRows()

Description copied from interface: ApiJobStore

A cold observable that emits a stream of JobRows until all JobRows have been retrieved from the store. If at any time an error is encountered, onError is invoked, and the stream halts.

Specified by:

getAllRows in interface ApiJobStore

Returns:

An Observable that emits a stream of all the JobRows in the store

getFilteredRows

public rx.Observable<JobRow> getFilteredRows(Set<JobRowFilter> jobRowFilter)

This method ignores the filters and returns an empty Observable.

Specified by:

getFilteredRows in interface ApiJobStore

Parameters:

jobRowFilter - A Set of JobRowFilters where each JobRowFilter contains the JobField to be filtered on, the filter operation and the values to be compared to.

Returns:

An empty Observable.