com.screenscraper.util.internal.services.iterator.model

Class IteratorInstance

java.lang.Object

com.screenscraper.util.internal.services.iterator.model.IteratorInstance

All Implemented Interfaces:

java.lang.Comparable<IteratorInstance>

public final class IteratorInstance
extends java.lang.Object
implements java.lang.Comparable<IteratorInstance>

An instance of an iterator. This uses the query from a specific iterator and contains a set of iterations that can be retrieved.

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
IteratorInstance(APIConnection apiConnection, org.jdom.Element element)

Method Summary

Modifier and Type	Method and Description
int	compareTo(IteratorInstance other)
void	delete()
boolean	equals(java.lang.Object o)
java.util.Collection<Iteration>	getAllIterations()
int	getCompletedCount()
java.util.Collection<Iteration>	getCompletedIterations()
java.util.Date	getCreationDate()
int	getErrorCount()
java.util.Collection<Iteration>	getErrorIterations()
java.lang.String	getId()
Iteration	getIterationForOffset(int offset)
Iterator	getIterator()
java.lang.String	getIteratorName()
java.util.Date	getLastUpdate()
Iteration	getNextIteration()
Iteration	getNextIteration(java.lang.Integer port, java.lang.String localUrl)
java.lang.String	getNote()
Iteration	getRandomIteration()
Iteration	getRandomIteration(java.lang.Integer port, java.lang.String localUrl)
java.util.Collection<Iteration>	getRemainingIterations()
java.util.Collection<Iteration>	getRunningIterations()
int	getTotalCount()
int	hashCode()
boolean	hasNext()
boolean	isPaused()
boolean	isPreloaded()
void	pause()
Iteration	peekNextIteration()
void	resume()
void	rollback(java.util.Date toDate)
void	rollback(java.lang.String amount)
(package private) void	setIterator(Iterator iterator)
void	setPreloaded()

Methods inherited from class java.lang.Object

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

Constructor Detail

IteratorInstance

IteratorInstance(APIConnection apiConnection,
                 @NotNull
                 org.jdom.Element element)

Method Detail

isPreloaded

public boolean isPreloaded()

setPreloaded

public void setPreloaded()

setIterator

void setIterator(Iterator iterator)

getIterator

@Nullable
public Iterator getIterator()

getIteratorName

@Nullable
public java.lang.String getIteratorName()

delete

public void delete()

hasNext

public boolean hasNext()

rollback

public void rollback(java.lang.String amount)

rollback

public void rollback(java.util.Date toDate)

pause

public void pause()

resume

public void resume()

getIterationForOffset

@Nullable
public Iteration getIterationForOffset(int offset)

peekNextIteration

@Nullable
public Iteration peekNextIteration()

getNextIteration

@Nullable
public Iteration getNextIteration()

getNextIteration

@Nullable
public Iteration getNextIteration(java.lang.Integer port,
                                             java.lang.String localUrl)

getRandomIteration

@Nullable
public Iteration getRandomIteration()

getRandomIteration

@Nullable
public Iteration getRandomIteration(java.lang.Integer port,
                                               java.lang.String localUrl)

getAllIterations

public java.util.Collection<Iteration> getAllIterations()

getErrorIterations

public java.util.Collection<Iteration> getErrorIterations()

getCompletedIterations

public java.util.Collection<Iteration> getCompletedIterations()

getRemainingIterations

public java.util.Collection<Iteration> getRemainingIterations()

getRunningIterations

public java.util.Collection<Iteration> getRunningIterations()

getId

@Nullable
public java.lang.String getId()

getNote

@Nullable
public java.lang.String getNote()

getCreationDate

public java.util.Date getCreationDate()

isPaused

public boolean isPaused()

getLastUpdate

public java.util.Date getLastUpdate()

getCompletedCount

public int getCompletedCount()

getErrorCount

public int getErrorCount()

getTotalCount

public int getTotalCount()

compareTo

public int compareTo(IteratorInstance other)

Specified by:

compareTo in interface java.lang.Comparable<IteratorInstance>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object