com.yosokumo.core
Class Block

java.lang.Object
  com.yosokumo.core.Block

Direct Known Subclasses:

EmptyBlock, PredictorBlock, SpecimenBlock

abstract class Block
extends java.lang.Object

An abstract base class for EmptyBlock, PredictorBlock, and SpecimenBlock. The Block class is package-private so it is unknown in the API. It is a way to package up Predictors and Specimens for transmission to the Yosokumo web service via HTTP.

Nested Class Summary

(package private) static class

Block.Type Indicates what is stored in the Block, e.g., Predictors, or Specimens.

Field Summary

private java.lang.String

studyIdentifier Specifies the study which the block is associated with.

Constructor Summary

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

Block(java.lang.String id)
Initializes a newly created Block object with a study identifier.

Method Summary

(package private) java.lang.String	getStudyIdentifier() Return the study identifier of the block.
(package private) abstract Block.Type	getType() Return the type of the block.
(package private) void	setStudyIdentifier(java.lang.String id) Set the study identifier of the block.
abstract java.lang.String	toString() Return the block as a String.

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

Specifies the study which the block is associated with.

Constructor Detail

Block

Block()

Initializes a newly created Block object with default attributes.

Block

Block(java.lang.String id)

Initializes a newly created Block object with a study identifier.

Parameters:

id - a study identifier for the block.

Method Detail

getType

abstract Block.Type getType()

Return the type of the block.

Returns:

the type of the block.

setStudyIdentifier

void setStudyIdentifier(java.lang.String id)

Set the study identifier of the block.

Parameters:

id - the identifier to assign to the block.

getStudyIdentifier

java.lang.String getStudyIdentifier()

Return the study identifier of the block.

Returns:

the study identifier of the block.

toString

public abstract java.lang.String toString()

Return the block as a String.

Overrides:

toString in class java.lang.Object

Returns:

the block as a String.