models.common

Class Study

java.lang.Object

models.common.Study

@Entity
public class Study
extends java.lang.Object

DB entity of a study. Used for JSON marshalling and JPA persistance. This entity has all properties of a study but not the results of a study. The results of a study are stored in StudyResults and ComponentResult. A study consists of a list components and their model is Component. It can have several Batches. Default values, where necessary, are at the fields or in the constructor. For the GUI a different model (models.gui.StudyProperties) is used.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SERIAL_VERSION Version of this model used for serialisation (e.g.
static java.lang.String	STUDY
static java.lang.String	USERS

Constructor Summary

Constructors

Constructor and Description
Study()

Method Summary

Modifier and Type	Method and Description
void	addBatch(Batch batch)
void	addComponent(Component component)
void	addUser(User user)
boolean	equals(java.lang.Object obj)
java.util.List<Batch>	getBatchList()
java.lang.String	getComments()
Component	getComponent(int position) Gets the component of this study at the given position.
java.util.List<Component>	getComponentList()
java.lang.Integer	getComponentPosition(Component component) Returns the position (index+1) of the component in the list of components of this study or null if it doesn't exist.
java.sql.Timestamp	getDate()
Batch	getDefaultBatch()
java.lang.String	getDescription()
java.lang.String	getDescriptionHash()
java.lang.String	getDirName()
java.lang.String	getEndRedirectUrl()
java.util.Optional<Component>	getFirstComponent()
java.lang.Long	getId()
java.lang.String	getJsonData()
java.util.Optional<Component>	getLastComponent()
java.util.Optional<Component>	getNextComponent(Component component)
java.lang.String	getStudyEntryMsg()
java.lang.String	getTitle()
java.util.Set<User>	getUserList()
java.lang.String	getUuid()
boolean	hasBatch(Batch batch)
boolean	hasComponent(Component component)
int	hashCode()
boolean	hasUser(User user)
boolean	isActive()
boolean	isAllowPreview()
boolean	isGroupStudy()
boolean	isLinearStudy()
boolean	isLocked()
void	removeBatch(Batch batch)
void	removeComponent(Component component)
void	removeUser(User user)
void	setActive(boolean active)
void	setAllowPreview(boolean allowPreview)
void	setBatchList(java.util.List<Batch> batchList)
void	setComments(java.lang.String comments)
void	setComponentList(java.util.List<Component> componentList)
void	setDate(java.sql.Timestamp timestamp)
void	setDescription(java.lang.String description)
void	setDirName(java.lang.String dirName)
void	setEndRedirectUrl(java.lang.String endRedirectUrl)
void	setGroupStudy(boolean groupStudy)
void	setId(java.lang.Long id)
void	setJsonData(java.lang.String jsonData)
void	setLinearStudy(boolean linearStudy)
void	setLocked(boolean locked)
void	setStudyEntryMsg(java.lang.String studyEntryMsg)
void	setTitle(java.lang.String title)
void	setUserList(java.util.Set<User> userList)
void	setUuid(java.lang.String uuid)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIAL_VERSION

public static final int SERIAL_VERSION

Version of this model used for serialisation (e.g. JSON marshaling)

See Also:

Constant Field Values

USERS

public static final java.lang.String USERS

See Also:

Constant Field Values

STUDY

public static final java.lang.String STUDY

See Also:

Constant Field Values

Constructor Detail

Study

public Study()

Method Detail

setId

public void setId(java.lang.Long id)

getId

public java.lang.Long getId()

setUuid

public void setUuid(java.lang.String uuid)

getUuid

public java.lang.String getUuid()

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

getDescriptionHash

public java.lang.String getDescriptionHash()

setDirName

public void setDirName(java.lang.String dirName)

getDirName

public java.lang.String getDirName()

setComments

public void setComments(java.lang.String comments)

getComments

public java.lang.String getComments()

setDate

public void setDate(java.sql.Timestamp timestamp)

getDate

public java.sql.Timestamp getDate()

setLocked

public void setLocked(boolean locked)

isLocked

public boolean isLocked()

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

isGroupStudy

public boolean isGroupStudy()

setGroupStudy

public void setGroupStudy(boolean groupStudy)

isLinearStudy

public boolean isLinearStudy()

setLinearStudy

public void setLinearStudy(boolean linearStudy)

isAllowPreview

public boolean isAllowPreview()

setAllowPreview

public void setAllowPreview(boolean allowPreview)

getJsonData

public java.lang.String getJsonData()

setJsonData

public void setJsonData(java.lang.String jsonData)

getEndRedirectUrl

public java.lang.String getEndRedirectUrl()

setEndRedirectUrl

public void setEndRedirectUrl(java.lang.String endRedirectUrl)

getStudyEntryMsg

public java.lang.String getStudyEntryMsg()

setStudyEntryMsg

public void setStudyEntryMsg(java.lang.String studyEntryMsg)

setUserList

public void setUserList(java.util.Set<User> userList)

getUserList

public java.util.Set<User> getUserList()

addUser

public void addUser(User user)

removeUser

public void removeUser(User user)

hasUser

public boolean hasUser(User user)

setComponentList

public void setComponentList(java.util.List<Component> componentList)

getComponentList

public java.util.List<Component> getComponentList()

getComponent

public Component getComponent(int position)

Gets the component of this study at the given position. The smallest position is 1 (and not 0 as in an array).

getComponentPosition

public java.lang.Integer getComponentPosition(Component component)

Returns the position (index+1) of the component in the list of components of this study or null if it doesn't exist.

addComponent

public void addComponent(Component component)

removeComponent

public void removeComponent(Component component)

hasComponent

public boolean hasComponent(Component component)

getFirstComponent

public java.util.Optional<Component> getFirstComponent()

getLastComponent

public java.util.Optional<Component> getLastComponent()

getNextComponent

public java.util.Optional<Component> getNextComponent(Component component)

setBatchList

public void setBatchList(java.util.List<Batch> batchList)

getBatchList

public java.util.List<Batch> getBatchList()

hasBatch

public boolean hasBatch(Batch batch)

addBatch

public void addBatch(Batch batch)

removeBatch

public void removeBatch(Batch batch)

getDefaultBatch

public Batch getDefaultBatch()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object