Package org.maproulette.client.batch

Class ChallengeBatch

java.lang.Object

org.maproulette.client.batch.ChallengeBatch

public class ChallengeBatch
extends java.lang.Object

Batches tasks for a challenge

Constructor Summary

Constructors

Constructor	Description
ChallengeBatch(IMapRouletteConnection connection, long challengeId, int maxBatchSize)
ChallengeBatch(MapRouletteConfiguration configuration, long challengeId)
ChallengeBatch(MapRouletteConfiguration configuration, Challenge challenge)	This constructor allows us to check whether the challenge has actually been created or not.

Method Summary

Modifier and Type	Method	Description
void	addTask(Task task)	Adds a task to the Challenge batch.
void	addTasks(java.util.List<Task> tasks)	Adds a set of Tasks to the batch.
void	flush()	Flushes all the tasks from the Challenge batch
java.util.List<Task>	getBatch()
long	getChallengeId()
static long	getChallengeId(MapRouletteConfiguration configuration, Challenge challenge)
IMapRouletteConnection	getConnection()
org.slf4j.Logger	getLogger()
com.fasterxml.jackson.databind.ObjectMapper	getMapper()
int	getMaxBatchSize()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChallengeBatch

public ChallengeBatch(MapRouletteConfiguration configuration,
                      long challengeId)

ChallengeBatch

public ChallengeBatch(MapRouletteConfiguration configuration,
                      Challenge challenge)

This constructor allows us to check whether the challenge has actually been created or not.

Parameters:

configuration - MapRouletteConfiguration object for the MapRoulette Server

challenge - The challenge to create if not exists on the server

ChallengeBatch

public ChallengeBatch(IMapRouletteConnection connection,
                      long challengeId,
                      int maxBatchSize)

Method Detail

getChallengeId

public static long getChallengeId(MapRouletteConfiguration configuration,
                                  Challenge challenge)

addTasks

public void addTasks(java.util.List<Task> tasks)
              throws MapRouletteException

Adds a set of Tasks to the batch. If the batch hits the maximum size it will automatically flush the batch.

Parameters:

tasks - The tasks to add to the batch.

Throws:

MapRouletteException - If it flushes, it may through a MapRouletteException when pushing data to MapRoulette

addTask

public void addTask(Task task)
             throws MapRouletteException

Adds a task to the Challenge batch. If the batch hits the maximum size it will automatially flush the batch.

Parameters:

task - Tasks are unique based on the Task identifier.

Throws:

MapRouletteException - If it flushes, it may through a MapRouletteException when pushing data to MapRoulette

flush

public void flush()
           throws MapRouletteException

Flushes all the tasks from the Challenge batch

Throws:

MapRouletteException - If there are any failures during the upload

getLogger

public org.slf4j.Logger getLogger()

getMapper

public com.fasterxml.jackson.databind.ObjectMapper getMapper()

getConnection

public IMapRouletteConnection getConnection()

getChallengeId

public long getChallengeId()

getMaxBatchSize

public int getMaxBatchSize()

getBatch

public java.util.List<Task> getBatch()