com.neurosys.q.service

Interface QStrategy<T extends Token<T>>

Type Parameters:

T - as Token

All Superinterfaces:

TokenEventSupplier<T>

public interface QStrategy<T extends Token<T>>
extends TokenEventSupplier<T>

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
boolean	allowAdd(TokenContainer<T> container, List<T> tokens) Business logic if we can allow a token to be added to the Q or not @ the TokenManager stage This should be called before a token is actually added to a Q.
void	autoAssignData(T token, Route<T> route) Set all sorts of Ids, or any data that can be automatically set for the Token that we may want to apply custom logic to. Typically this should be called after a Token is assigned its Batch or Shift.
<R extends Route<T>> R	determineRoute(T token) What is the route for a token
Number	getTokenPriority(T token) A Number where higher denotes more important and lesser denotes lesser importance.

Methods inherited from interface com.neurosys.q.service.TokenEventSupplier

onTokenChange

Method Detail

getTokenPriority

Number getTokenPriority(T token)

A Number where higher denotes more important and lesser denotes lesser importance.

Returns:

@nullable true

determineRoute

<R extends Route<T>> R determineRoute(T token)

What is the route for a token

Parameters:

token - as Token

Returns:

Route

allowAdd

boolean allowAdd(TokenContainer<T> container,
                 List<T> tokens)
          throws TokenGenerationException

Business logic if we can allow a token to be added to the Q or not @ the TokenManager stage
This should be called before a token is actually added to a Q.

Parameters:

container - as TokenContainer

tokens - as List of Tokens

Returns:

boolean

Throws:

TokenGenerationException

autoAssignData

void autoAssignData(T token,
                    Route<T> route)

Set all sorts of Ids, or any data that can be automatically set for the Token that we may want to apply custom logic to.
Typically this should be called after a Token is assigned its Batch or Shift.
Called typically after determineRoute(Token) as Shift needs to be known the Token is assigned to.

Parameters:

token - as Token type

route - as Route