services.publix.idcookie

Class IdCookieCollection

java.lang.Object

services.publix.idcookie.IdCookieCollection

public class IdCookieCollection
extends java.lang.Object

Wrapper around a collection of IdCookies. Adds some useful methods. The number of IdCookies are limited to to 10.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ID_COOKIES Max number of ID cookies.

Constructor Summary

Constructors

Constructor and Description
IdCookieCollection()

Method Summary

Modifier and Type	Method and Description
protected IdCookieModel	add(IdCookieModel idCookie) Stores the given IdCookie.
protected IdCookieModel	findWithStudyResultId(long studyResultId) Returns the IdCookie to which the specified study result ID is mapped, or null if nothing maps to the ID.
protected java.util.Collection<IdCookieModel>	getAll()
protected int	getNextAvailableIdCookieIndex() Returns a number from 0 to 10.
protected boolean	isFull()
protected IdCookieModel	put(IdCookieModel idCookie) Stores the given IdCookie.
protected IdCookieModel	remove(IdCookieModel idCookie)
protected int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ID_COOKIES

public static final int MAX_ID_COOKIES

Max number of ID cookies. If all cookies are used and a new study is started, the oldest ID cookie will be overwritten.

Important note: jatos.js supports only up to 10 cookies so far.

See Also:

Constant Field Values

Constructor Detail

IdCookieCollection

public IdCookieCollection()

Method Detail

isFull

protected boolean isFull()

size

protected int size()

add

protected IdCookieModel add(IdCookieModel idCookie)
                     throws IdCookieAlreadyExistsException

Stores the given IdCookie. If an IdCookie with the same study result ID is already stored an IdCookieAlreadyExistsException is thrown. If the max number of cookies is reached an IdCookieCollectionFullException is thrown.

Throws:

IdCookieAlreadyExistsException

put

protected IdCookieModel put(IdCookieModel idCookie)
                     throws IdCookieCollectionFullException

Stores the given IdCookie. If an IdCookie with the same study result ID is already stored it gets overwritten. If the max number of cookies is reached an IdCookieCollectionFullException is thrown.

Throws:

IdCookieCollectionFullException

remove

protected IdCookieModel remove(IdCookieModel idCookie)

getAll

protected java.util.Collection<IdCookieModel> getAll()

getNextAvailableIdCookieIndex

protected int getNextAvailableIdCookieIndex()

Returns a number from 0 to 10. It iterates through the IdCookies and returns the first index that isn't used. Index refers here to the index of the IdCookie which is the last char of its name. If this IdCookieCollection is full a IndexOutOfBoundsException will be thrown.

findWithStudyResultId

protected IdCookieModel findWithStudyResultId(long studyResultId)

Returns the IdCookie to which the specified study result ID is mapped, or null if nothing maps to the ID.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object