com.yosokumo.core
Class Study

java.lang.Object
  com.yosokumo.core.Study

public class Study
extends java.lang.Object

A container for all resources associated with an analytic project. A study has these attributes:

• a study identifier and a study name
• a type, a status, and a visibility
• an identifier and a name of the user who owns the study
• references to the table, model, panel, and roster for the study

Nested Class Summary

static class	Study.Status Describes the state of the study, whether it is running, on standby, or stopped.
static class	Study.Type Indicates the quality of the predictands associated with subjects in the study.
static class	Study.Visibility Tells whether unidentified users can get estimated predictands from the model of the study.

Field Summary

private long	blockCount
private long	cellCount
private java.lang.String	creationTime
private java.lang.String	latestBlockTime
private java.lang.String	latestProspectTime
private java.lang.String	modelLocation
private java.lang.String	nameControlLocation
private java.lang.String	ownerIdentifier
private java.lang.String	ownerName
private java.lang.String	panelLocation
private long	prospectCount
private java.lang.String	rosterLocation
private Study.Status	status
private java.lang.String	statusControlLocation
private java.lang.String	studyIdentifier
private java.lang.String	studyLocation
private java.lang.String	studyName
private java.lang.String	tableLocation
private Study.Type	type
private Study.Visibility	visibility
private java.lang.String	visibilityControlLocation

Constructor Summary

Study()
Initializes a newly created Study object with default attributes.

Study(java.lang.String studyName, Study.Type type, Study.Status status, Study.Visibility visibility)
Initializes a newly created Study object with attributes specified by the input parameters.

Method Summary

(package private) static Study	copyStudy(Study s) Make a copy of a study.
long	getBlockCount() Return the block count.
long	getCellCount() Return the cell count.
java.lang.String	getCreationTime() Return the creation time.
java.lang.String	getLatestBlockTime() Return the latest block time.
java.lang.String	getLatestProspectTime() Return the latest prospect time.
(package private) java.lang.String	getModelLocation() Return the model location.
(package private) java.lang.String	getNameControlLocation() Return the name control location.
java.lang.String	getOwnerIdentifier() Return the owner identifier.
java.lang.String	getOwnerName() Return the owner name.
(package private) java.lang.String	getPanelLocation() Return the panel location.
long	getProspectCount() Return the prospect count.
(package private) java.lang.String	getRosterLocation() Return the roster location.
Study.Status	getStatus() Return the study status.
(package private) java.lang.String	getStatusControlLocation() Return the status control location.
java.lang.String	getStudyIdentifier() Return the study identifier.
(package private) java.lang.String	getStudyLocation() Return the study location.
java.lang.String	getStudyName() Return the study name.
(package private) java.lang.String	getTableLocation() Return the table location.
Study.Type	getType() Return the study type.
Study.Visibility	getVisibility() Return the study visibility.
(package private) java.lang.String	getVisibilityControlLocation() Return the visibility control location.
(package private) void	setBlockCount(long blockCount) Set the block count.
(package private) void	setCellCount(long cellCount) Set the cell count.
(package private) void	setCreationTime(java.lang.String creationTime) Set the creation time.
(package private) void	setLatestBlockTime(java.lang.String latestBlockTime) Set the latest block time.
(package private) void	setLatestProspectTime(java.lang.String latestProspectTime) Set the latest prospect time.
(package private) void	setModelLocation(java.lang.String loc) Set the model location.
(package private) void	setNameControlLocation(java.lang.String nameControlLocation) Set the name control location.
(package private) void	setOwnerIdentifier(java.lang.String id) Set the owner identifier.
(package private) void	setOwnerName(java.lang.String name) Set the owner name.
(package private) void	setPanelLocation(java.lang.String loc) Set the panel location.
(package private) void	setProspectCount(long prospectCount) Set the prospect count.
(package private) void	setRosterLocation(java.lang.String loc) Set the roster location.
(package private) void	setStatus(Study.Status s) Set the study status.
(package private) void	setStatusControlLocation(java.lang.String statusControlLocation) Set the status control location.
(package private) void	setStudyIdentifier(java.lang.String id) Set the study identifier.
(package private) void	setStudyLocation(java.lang.String loc) Set the study location.
(package private) void	setStudyName(java.lang.String name) Set the study name.
(package private) void	setTableLocation(java.lang.String loc) Set the table location.
(package private) void	setType(Study.Type t) Set the study type.
(package private) void	setVisibility(Study.Visibility v) Set the study visibility.
(package private) void	setVisibilityControlLocation(java.lang.String visibilityControlLocation) Set the visibility control location.
java.lang.String	toString() Return a string representation of this Study.
(package private) java.lang.String	toStringInternal(boolean showAll) Return a string representation of this Study.

Methods inherited from class java.lang.Object

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

Field Detail

studyIdentifier

private java.lang.String studyIdentifier

studyName

private java.lang.String studyName

studyLocation

private java.lang.String studyLocation

type

private Study.Type type

status

private Study.Status status

visibility

private Study.Visibility visibility

ownerIdentifier

private java.lang.String ownerIdentifier

ownerName

private java.lang.String ownerName

tableLocation

private java.lang.String tableLocation

modelLocation

private java.lang.String modelLocation

panelLocation

private java.lang.String panelLocation

rosterLocation

private java.lang.String rosterLocation

nameControlLocation

private java.lang.String nameControlLocation

statusControlLocation

private java.lang.String statusControlLocation

visibilityControlLocation

private java.lang.String visibilityControlLocation

blockCount

private long blockCount

cellCount

private long cellCount

prospectCount

private long prospectCount

creationTime

private java.lang.String creationTime

latestBlockTime

private java.lang.String latestBlockTime

latestProspectTime

private java.lang.String latestProspectTime

Constructor Detail

Study

Study()

Initializes a newly created Study object with default attributes.

• identifier ""
• name ""
• type NUMBER
• status RUNNING
• visibility PRIVATE

The type of a Study cannot be changed after construction.

Study

Study(java.lang.String studyName,
      Study.Type type,
      Study.Status status,
      Study.Visibility visibility)

Initializes a newly created Study object with attributes specified by the input parameters.

Parameters:

studyName - the name of the study.

type - the type of the study.

status - the status of the study.

visibility - the visibility of the study. The type of a Study cannot be changed after construction.

Method Detail

copyStudy

static Study copyStudy(Study s)

Make a copy of a study.

Parameters:

s - the study to copy.

Returns:

a copy of s.

setStudyIdentifier

void setStudyIdentifier(java.lang.String id)

Set the study identifier.

Parameters:

id - the identifier to assign to this study. This is the unique identification of the study. May be null.

getStudyIdentifier

public java.lang.String getStudyIdentifier()

Return the study identifier.

Returns:

the identifier of this study, which is the unique identification of the study. May be null.

setStudyName

void setStudyName(java.lang.String name)

Set the study name.

Parameters:

name - the name to assign to this study. May be null.

getStudyName

public java.lang.String getStudyName()

Return the study name.

Returns:

the name of this study. May be null.

setStudyLocation

void setStudyLocation(java.lang.String loc)

Set the study location.

Parameters:

loc - the location to assign to this study. May be null.

getStudyLocation

java.lang.String getStudyLocation()

Return the study location.

Returns:

the location of this study. May be null.

setType

void setType(Study.Type t)

Set the study type.

Parameters:

t - the type to assign to this study.

getType

public Study.Type getType()

Return the study type.

Returns:

the type of this study.

setStatus

void setStatus(Study.Status s)

Set the study status.

Parameters:

s - the status to assign to this study.

getStatus

public Study.Status getStatus()

Return the study status.

Returns:

the status of this study.

setVisibility

void setVisibility(Study.Visibility v)

Set the study visibility.

Parameters:

v - the type to assign to this study.

getVisibility

public Study.Visibility getVisibility()

Return the study visibility.

Returns:

the visibility of this study.

setOwnerIdentifier

void setOwnerIdentifier(java.lang.String id)

Set the owner identifier.

Parameters:

id - the identifier of the owner of this study. May be null.

getOwnerIdentifier

public java.lang.String getOwnerIdentifier()

Return the owner identifier.

Returns:

the identifier of the owner of this study. May be null.

setOwnerName

void setOwnerName(java.lang.String name)

Set the owner name.

Parameters:

name - the name to assign to the owner of this study. May be null.

getOwnerName

public java.lang.String getOwnerName()

Return the owner name.

Returns:

the name of the owner of this study. May be null.

setTableLocation

void setTableLocation(java.lang.String loc)

Set the table location.

Parameters:

loc - the location of the table for this study. May be null.

getTableLocation

java.lang.String getTableLocation()

Return the table location.

Returns:

the location of the table for this study. May be null.

setModelLocation

void setModelLocation(java.lang.String loc)

Set the model location.

Parameters:

loc - the location of the model for this study. May be null.

getModelLocation

java.lang.String getModelLocation()

Return the model location.

Returns:

the location of the model for this study. May be null.

setPanelLocation

void setPanelLocation(java.lang.String loc)

Set the panel location.

Parameters:

loc - the location of the panel for this study. May be null.

getPanelLocation

java.lang.String getPanelLocation()

Return the panel location.

Returns:

the location of the panel for this study. May be null.

setRosterLocation

void setRosterLocation(java.lang.String loc)

Set the roster location.

Parameters:

loc - the location of the roster for this study. May be null.

getRosterLocation

java.lang.String getRosterLocation()

Return the roster location.

Returns:

the location of the roster for this study. May be null.

setNameControlLocation

void setNameControlLocation(java.lang.String nameControlLocation)

Set the name control location.

Parameters:

nameControlLocation - the URI to use to change the name of the study.

getNameControlLocation

java.lang.String getNameControlLocation()

Return the name control location.

Returns:

the URI to use to change the name of the study.

setStatusControlLocation

void setStatusControlLocation(java.lang.String statusControlLocation)

Set the status control location.

Parameters:

statusControlLocation - the URI to use to change the status of the study.

getStatusControlLocation

java.lang.String getStatusControlLocation()

Return the status control location.

Returns:

the URI to use to change the status of the study.

setVisibilityControlLocation

void setVisibilityControlLocation(java.lang.String visibilityControlLocation)

Set the visibility control location.

Parameters:

visibilityControlLocation - the URI to use to change the visibility of the study.

getVisibilityControlLocation

java.lang.String getVisibilityControlLocation()

Return the visibility control location.

Returns:

the URI to use to change the visibility of the study.

setBlockCount

void setBlockCount(long blockCount)

Set the block count.

Parameters:

blockCount - the number of posted blocks that have been accepted into the study table.

getBlockCount

public long getBlockCount()

Return the block count.

Returns:

the number of posted blocks that have been accepted into the study table.

setCellCount

void setCellCount(long cellCount)

Set the cell count.

Parameters:

cellCount - the total number of cells contained in the blocks reported in the block count.

getCellCount

public long getCellCount()

Return the cell count.

Returns:

the total number of cells contained in the blocks reported in the block count.

setProspectCount

void setProspectCount(long prospectCount)

Set the prospect count.

Parameters:

prospectCount - the total number of specimens contained in all Post Model and Get Model requests for the study.

getProspectCount

public long getProspectCount()

Return the prospect count.

Returns:

the total number of specimens contained in all Post Model and Get Model requests for the study.

setCreationTime

void setCreationTime(java.lang.String creationTime)

Set the creation time.

Parameters:

creationTime - the UTC time the study was created.

getCreationTime

public java.lang.String getCreationTime()

Return the creation time.

Returns:

the UTC time the study was created.

setLatestBlockTime

void setLatestBlockTime(java.lang.String latestBlockTime)

Set the latest block time.

Parameters:

latestBlockTime - the UTC time that the service accepted the most recent block into the study table.

getLatestBlockTime

public java.lang.String getLatestBlockTime()

Return the latest block time.

Returns:

the UTC time that the service accepted the most recent block into the study table.

setLatestProspectTime

void setLatestProspectTime(java.lang.String latestProspectTime)

Set the latest prospect time.

Parameters:

latestProspectTime - the UTC time of the most recent Post Model or Get Model request.

getLatestProspectTime

public java.lang.String getLatestProspectTime()

Return the latest prospect time.

Returns:

the UTC time of the most recent Post Model or Get Model request.

toString

public java.lang.String toString()

Return a string representation of this Study.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this Study.

toStringInternal

java.lang.String toStringInternal(boolean showAll)

Return a string representation of this Study.

Parameters:

showAll - specifies if internal data members should be shown.

Returns:

the string representation of this Study.