org.mitre.data

Class AbstractPageOperationTemplate<T>

java.lang.Object

org.mitre.data.AbstractPageOperationTemplate<T>

Type Parameters:

T - the type parameter

public abstract class AbstractPageOperationTemplate<T>
extends Object

Abstract class for performing an operation on a potentially large number of items by paging through the items in discreet chunks.

Author:

Colm Smyth.

Constructor Summary

Constructors

Constructor and Description
AbstractPageOperationTemplate(int maxPages, long maxTime, String operationName) Instantiates a new AbstractPageOperationTemplate with the given maxPages and maxTime
AbstractPageOperationTemplate(String operationName) default constructor which sets the value of maxPages and maxTime to DEFAULT_MAX_PAGES and DEFAULT_MAX_TIME_MILLIS respectively

Method Summary

Modifier and Type	Method and Description
protected abstract void	doOperation(T item) method responsible for performing desired operation on a fetched page item.
void	execute() Execute the operation on each member of a page of results retrieved through the fetch method.
abstract Collection<T>	fetchPage() method responsible for fetching a page of items.
protected void	finalReport(int operationsCompleted, int exceptionsSwallowedCount, Set<String> exceptionsSwallowedClasses) Method responsible for final report of progress.
int	getMaxPages()
long	getMaxTime()
String	getOperationName()
boolean	isSwallowExceptions()
void	setMaxPages(int maxPages)
void	setMaxTime(long maxTime)
void	setOperationName(String operationName)
void	setSwallowExceptions(boolean swallowExceptions)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPageOperationTemplate

public AbstractPageOperationTemplate(String operationName)

default constructor which sets the value of maxPages and maxTime to DEFAULT_MAX_PAGES and DEFAULT_MAX_TIME_MILLIS respectively

AbstractPageOperationTemplate

public AbstractPageOperationTemplate(int maxPages,
                                     long maxTime,
                                     String operationName)

Instantiates a new AbstractPageOperationTemplate with the given maxPages and maxTime

Parameters:

maxPages - the maximum number of pages to fetch.

maxTime - the maximum execution time.

Method Detail

execute

public void execute()

Execute the operation on each member of a page of results retrieved through the fetch method. the method will execute until either the maxPages or maxTime limit is reached or until the fetch method returns no more results. Exceptions thrown performing the operation on the item will be swallowed if the swallowException (default true) field is set true.

fetchPage

public abstract Collection<T> fetchPage()

method responsible for fetching a page of items.

Returns:

the collection of items

doOperation

protected abstract void doOperation(T item)

method responsible for performing desired operation on a fetched page item.

Parameters:

item - the item

finalReport

protected void finalReport(int operationsCompleted,
                           int exceptionsSwallowedCount,
                           Set<String> exceptionsSwallowedClasses)

Method responsible for final report of progress.

getMaxPages

public int getMaxPages()

setMaxPages

public void setMaxPages(int maxPages)

getMaxTime

public long getMaxTime()

setMaxTime

public void setMaxTime(long maxTime)

isSwallowExceptions

public boolean isSwallowExceptions()

setSwallowExceptions

public void setSwallowExceptions(boolean swallowExceptions)

getOperationName

public String getOperationName()

Returns:

the operationName

setOperationName

public void setOperationName(String operationName)

Parameters:

operationName - the operationName to set