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.

Method Summary

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.
java.lang.String	getOwnerIdentifier() Return the owner identifier.
java.lang.String	getOwnerName() Return the owner name.
long	getProspectCount() Return the prospect count.
Study.Status	getStatus() Return the study status.
java.lang.String	getStudyIdentifier() Return the study identifier.
java.lang.String	getStudyName() Return the study name.
Study.Type	getType() Return the study type.
Study.Visibility	getVisibility() Return the study visibility.
java.lang.String	toString() Return a string representation of this Study.

Methods inherited from class java.lang.Object

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

Method Detail

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.

getStudyName

public java.lang.String getStudyName()

Return the study name.

Returns:

the name of this study. May be null.

getType

public Study.Type getType()

Return the study type.

Returns:

the type of this study.

getStatus

public Study.Status getStatus()

Return the study status.

Returns:

the status of this study.

getVisibility

public Study.Visibility getVisibility()

Return the study visibility.

Returns:

the visibility of this study.

getOwnerIdentifier

public java.lang.String getOwnerIdentifier()

Return the owner identifier.

Returns:

the identifier of 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.

getBlockCount

public long getBlockCount()

Return the block count.

Returns:

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

getCellCount

public long getCellCount()

Return the cell count.

Returns:

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

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.

getCreationTime

public java.lang.String getCreationTime()

Return the creation time.

Returns:

the UTC time the study was created.

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.

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.