com.neurosys.q.domain

Interface Batch<T extends Token<T>>

Type Parameters:

T - as Token type

All Superinterfaces:

Chainable<T>, Collection<T>, Comparable<T>, Displayable, FlowState, GUID, Iterable<T>, Notification, Queue<T>, Serializable, Token<T>, TokenContainer<T>

public interface Batch<T extends Token<T>>
extends Token<T>, Queue<T>, TokenContainer<T>

A batch of Tokens.
Also since Batch extends Token A Batch can contain other Batches. So one can represent a Queue as a Batch or a Batch of batch.

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
Object	getId() The Id for the batch
Object	getParentId() Each Batch operates within a Shift or some owning concept. Return its id
Number	getSequence(T token) Get the index of the Token in the Batch if it exists.
List<T>	getTokens() Gets the current tokens in the Batch Please note that the state of tokens can keep changing real-time.
int	size() Since calling getTokens() can be expensive, explicitly providing this where we do not care about the tokens but just the batch size.

Methods inherited from interface com.neurosys.q.domain.Token

getBatchInfo, getCounter, getStatus, setStatus

Methods inherited from interface com.neurosys.guid.GUID

getGUID, setGUID

Methods inherited from interface com.neurosys.workflow.domain.FlowState

getCreated, getFlowStatus, getStatusDate, getUpdated

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.neurosys.domain.Chainable

chain

Methods inherited from interface com.neurosys.domain.Displayable

getDisplayName

Methods inherited from interface java.util.Queue

add, element, offer, peek, poll, remove

Methods inherited from interface java.util.Collection

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface com.neurosys.q.domain.TokenContainer

getName, remove

Method Detail

getTokens

List<T> getTokens()

Gets the current tokens in the Batch
Please note that the state of tokens can keep changing real-time. So two subsequent calls to this may not yield the same results in a real time scenario.

Returns:

size

int size()

Since calling getTokens() can be expensive, explicitly providing this where we do not care about the tokens but just the batch size.

Specified by:

size in interface Collection<T extends Token<T>>

Returns:

getSequence

Number getSequence(T token)

Get the index of the Token in the Batch if it exists. Number index starts from 0.

Parameters:

token - as

Returns:

null if it does not exist

getId

Object getId()

The Id for the batch

Specified by:

getId in interface Token<T extends Token<T>>

Specified by:

getId in interface TokenContainer<T extends Token<T>>

getParentId

Object getParentId()

Each Batch operates within a Shift or some owning concept.
Return its id