A C D E G I K L M N O P R S T U V

A

addAllPrivileges() - Method in class com.yosokumo.core.Role

Add all privileges.

addPrivilege(Role.Privilege) - Method in class com.yosokumo.core.Role

Add a privilege.

C

Catalog - Class in com.yosokumo.core

An index to all the studies on which a given user has a role.

Cell - Class in com.yosokumo.core

Represents a Value with an associated key or name.

Cell(long, Value) - Constructor for class com.yosokumo.core.Cell

com.yosokumo.core - package com.yosokumo.core

Implements Java classes which allow a Yosokumo analytic project to be manipulated as a collection of Java objects; the Java programmer using these classes need not be concerned with the details of HTTP access to the Yosokumo web service.

containsRole(String) - Method in class com.yosokumo.core.Roster

Test if a role is in the roster.

containsStudy(String) - Method in class com.yosokumo.core.Catalog

Test if a study is in the catalog.

createRole(Role) - Method in class com.yosokumo.core.Service

Add a Role to a study's roster.

createStudy() - Method in class com.yosokumo.core.Service

Create a default study and add it to the user's catalog of studies.

createStudy(String) - Method in class com.yosokumo.core.Service

Create a named study and add it to the user's catalog of studies.

createStudy(String, Study.Type) - Method in class com.yosokumo.core.Service

Create a study with specified name and type and add it to the user's catalog of studies.

createStudy(String, Study.Type, Study.Status, Study.Visibility) - Method in class com.yosokumo.core.Service

Create a study with specified name, type, status, and visibility, and add it to the user's catalog of studies.

Credentials - Class in com.yosokumo.core

Specifies credentials (user id and key) for Yosokumo authentication.

Credentials(String, byte[]) - Constructor for class com.yosokumo.core.Credentials

Initializes a newly created Credentials object to the user id and key given as parameters.

D

deleteRole(String, String) - Method in class com.yosokumo.core.Service

Delete a role.

deleteStudy(String) - Method in class com.yosokumo.core.Service

Delete a study from the server.

describePredictors(String, List<Predictor>) - Method in class com.yosokumo.core.Service

Describe a study's predictors.

E

EmptyValue - Class in com.yosokumo.core

Represents no value or an unknown value.

EmptyValue() - Constructor for class com.yosokumo.core.EmptyValue

G

getBlockCount() - Method in class com.yosokumo.core.Study

Return the block count.

getCellCount() - Method in class com.yosokumo.core.Study

Return the cell count.

getCells() - Method in class com.yosokumo.core.Specimen

Return all cells in the cell sequence as a List<Cell>.

getCreationTime() - Method in class com.yosokumo.core.Study

Return the creation time.

getFailedMethodName() - Method in exception com.yosokumo.core.ServiceException

Return the name of the Service method which failed with this exception.

getKey() - Method in class com.yosokumo.core.Cell

Return the key of the cell.

getKey() - Method in class com.yosokumo.core.Credentials

Return a copy of the user key.

getLatestBlockTime() - Method in class com.yosokumo.core.Study

Return the latest block time.

getLatestProspectTime() - Method in class com.yosokumo.core.Study

Return the latest prospect time.

getLevel() - Method in class com.yosokumo.core.Predictor

Return the predictor level.

getName() - Method in class com.yosokumo.core.Cell

Return the name of the cell.

getNumber() - Method in enum com.yosokumo.core.Role.Privilege

Return the Privilege enum value as an integer.

getOwnerIdentifier() - Method in class com.yosokumo.core.Study

Return the owner identifier.

getOwnerName() - Method in class com.yosokumo.core.Study

Return the owner name.

getPredictand() - Method in class com.yosokumo.core.Specimen

Return the specimen predictand.

getPredictorName() - Method in class com.yosokumo.core.Predictor

Return the predictor name.

getPrivilege(Role.Privilege) - Method in class com.yosokumo.core.Role

Get a specific privilege.

getProspectCount() - Method in class com.yosokumo.core.Study

Return the prospect count.

getRole(String) - Method in class com.yosokumo.core.Roster

Return a role from the roster.

getRoleCollection() - Method in class com.yosokumo.core.Roster

Return all roles in the roster as a Collection<Role>.

getSpecimenKey() - Method in class com.yosokumo.core.Specimen

Return the specimen key.

getStatus() - Method in class com.yosokumo.core.Predictor

Return the predictor status.

getStatus() - Method in class com.yosokumo.core.Specimen

Return the specimen status.

getStatus() - Method in class com.yosokumo.core.Study

Return the study status.

getStatusCode() - Method in class com.yosokumo.core.Service

Return the status code from the last Service operation.

getStatusCode() - Method in exception com.yosokumo.core.ServiceException

Return HTTP status code.

getStudy(String) - Method in class com.yosokumo.core.Catalog

Return a study from the catalog.

getStudyCollection() - Method in class com.yosokumo.core.Catalog

Return all studies in the catalog as a Collection<Study>.

getStudyIdentifier() - Method in class com.yosokumo.core.Role

Return the study identifier.

getStudyIdentifier() - Method in class com.yosokumo.core.Roster

Return the study identifier.

getStudyIdentifier() - Method in class com.yosokumo.core.Study

Return the study identifier.

getStudyIdentifiersSet() - Method in class com.yosokumo.core.Catalog

Return the identifiers of all the studies in the catalog as a Set<String>.

getStudyName() - Method in class com.yosokumo.core.Role

Return the study name.

getStudyName() - Method in class com.yosokumo.core.Roster

Return the study name.

getStudyName() - Method in class com.yosokumo.core.Study

Return the study name.

getText() - Method in class com.yosokumo.core.Message

Return the message text.

getType() - Method in class com.yosokumo.core.EmptyValue

getType() - Method in class com.yosokumo.core.IntegerValue

Return the integer type.

getType() - Method in class com.yosokumo.core.Message

Return the message type.

getType() - Method in class com.yosokumo.core.NaturalValue

Return the natural type.

getType() - Method in class com.yosokumo.core.Predictor

Return the predictor type.

getType() - Method in class com.yosokumo.core.RealValue

Return the real type.

getType() - Method in class com.yosokumo.core.SpecialValue

Return the special value type.

getType() - Method in class com.yosokumo.core.Study

Return the study type.

getType() - Method in class com.yosokumo.core.Value

Return the type of the value.

getUserId() - Method in class com.yosokumo.core.Credentials

Return the user id.

getUserIdentifier() - Method in class com.yosokumo.core.Catalog

Return the user identifier.

getUserIdentifier() - Method in class com.yosokumo.core.Role

Return the user identifier.

getUserIdentifiersSet() - Method in class com.yosokumo.core.Roster

Return the user identifiers of all the roles in the roster as a Set<String>.

getUserName() - Method in class com.yosokumo.core.Catalog

Return the user name.

getUserName() - Method in class com.yosokumo.core.Role

Return the user name.

getValue() - Method in class com.yosokumo.core.Cell

Return the value of the cell.

getValue() - Method in class com.yosokumo.core.EmptyValue

Return the value stored in this empty object.

getValue() - Method in class com.yosokumo.core.IntegerValue

Return the integer value stored in this object.

getValue() - Method in class com.yosokumo.core.NaturalValue

Return the natural value stored in this object.

getValue() - Method in class com.yosokumo.core.RealValue

Return the real value stored in this object.

getValue() - Method in class com.yosokumo.core.SpecialValue

Return the special value stored in this object.

getVisibility() - Method in class com.yosokumo.core.Study

Return the study visibility.

getWeight() - Method in class com.yosokumo.core.Specimen

Return the specimen weight.

I

IntegerValue - Class in com.yosokumo.core

Represents a signed integer value.

IntegerValue(long) - Constructor for class com.yosokumo.core.IntegerValue

Initialize a newly created IntegerValue object with the value specified by the input parameter.

isEmpty() - Method in class com.yosokumo.core.Catalog

Return true if the catalog contains no studies.

isEmpty() - Method in class com.yosokumo.core.Roster

Return true if the roster contains no roles.

isEmpty() - Method in class com.yosokumo.core.Specimen

Return true if the sequence contains no cells.

K

KEY_LEN - Static variable in class com.yosokumo.core.Credentials

The exact length of a key.

keyToString(byte[]) - Static method in class com.yosokumo.core.Credentials

Return a string representation of a key.

L

loadSubjects(String, List<Specimen>) - Method in class com.yosokumo.core.Service

Populate the rows of a study's table with subjects.

M

Message - Class in com.yosokumo.core

A text message with a type indicating if the message is information or an error.

Message.Type - Enum in com.yosokumo.core

Indicates whether the message is informational or an error message.

N

NaturalValue - Class in com.yosokumo.core

Represents an unsigned integer value.

NaturalValue(long) - Constructor for class com.yosokumo.core.NaturalValue

Initialize a newly created NaturalValue object with the value specified by the input parameter.

numberOfPrivileges() - Static method in enum com.yosokumo.core.Role.Privilege

Return the number of privileges.

O

obtainCatalog() - Method in class com.yosokumo.core.Service

Obtain the user's catalog of studies.

obtainRole(String, String) - Method in class com.yosokumo.core.Service

Obtain a role.

obtainRoster(String) - Method in class com.yosokumo.core.Service

Obtain the roster for a study.

obtainStudy(String) - Method in class com.yosokumo.core.Service

Obtain a study from the server.

P

Predictor - Class in com.yosokumo.core

A column of values, an independent variable.

Predictor(long) - Constructor for class com.yosokumo.core.Predictor

Initializes a newly created Predictor object with default attributes.

Predictor(long, Predictor.Status, Predictor.Type, Predictor.Level) - Constructor for class com.yosokumo.core.Predictor

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

Predictor.Level - Enum in com.yosokumo.core

Indicates the level of measurement for the feature.

Predictor.Status - Enum in com.yosokumo.core

Provides a logical delete facility.

Predictor.Type - Enum in com.yosokumo.core

Describes the quality of the predictor and determines the statistical operations that can be performed on the feature.

R

RealValue - Class in com.yosokumo.core

Represents a floating-point value.

RealValue(double) - Constructor for class com.yosokumo.core.RealValue

Initialize a newly created RealValue object with the value specified by the input parameter.

removeAllPrivileges() - Method in class com.yosokumo.core.Role

Remove all privileges.

removePrivilege(Role.Privilege) - Method in class com.yosokumo.core.Role

Remove a privilege.

Role - Class in com.yosokumo.core

A set of privileges granted to a particular user for a particular study.

Role(String, String) - Constructor for class com.yosokumo.core.Role

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

Role.Privilege - Enum in com.yosokumo.core

Indicates an operation which a given user is or is not allowed to perform on a given study.

Roster - Class in com.yosokumo.core

For each study, a list of users that have a role on the study.

S

scoreProspects(String, List<Specimen>) - Method in class com.yosokumo.core.Service

Score prospects (compute predictands) using a study's model.

Service - Class in com.yosokumo.core

Provides the basic operations available from the Yosokumo web service, e.g., obtainCatalog and createStudy.

Service() - Constructor for class com.yosokumo.core.Service

Initializes a newly created Service object using defaults for the credentials, host name, port, and DIF.

Service(Credentials) - Constructor for class com.yosokumo.core.Service

Initializes a newly created Service object with attributes specified by the input parameters, using defaults for the host name, port, and DIF.

Service(Credentials, String) - Constructor for class com.yosokumo.core.Service

Initializes a newly created Service object with attributes specified by the input parameters, using defaults for the port and DIF.

Service(Credentials, String, int) - Constructor for class com.yosokumo.core.Service

Initializes a newly created Service object with attributes specified by the input parameters, using a default for the DIF.

Service(Credentials, String, int, Service.DIFType) - Constructor for class com.yosokumo.core.Service

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

Service.DIFType - Enum in com.yosokumo.core

Specifies the Data Interchange Format (DIF) of bytes transmitted to and from the Yosokumo server.

ServiceException - Exception in com.yosokumo.core

Encapsulates all exceptions which can be thrown by the Yosokumo Service.

ServiceException(String) - Constructor for exception com.yosokumo.core.ServiceException

Constructs a new exception with the specified detail message.

ServiceException(String, Throwable) - Constructor for exception com.yosokumo.core.ServiceException

Constructs a new exception with the specified detail message and cause.

ServiceException(String, Throwable, int, String) - Constructor for exception com.yosokumo.core.ServiceException

Constructs a new exception with the specified detail message, cause, status code and failed method name.

setCells(List<Cell>) - Method in class com.yosokumo.core.Specimen

Set the cells of this Specimen to the cell list specified by the parameter.

setLevel(Predictor.Level) - Method in class com.yosokumo.core.Predictor

Set the predictor level.

setPredictand(Value) - Method in class com.yosokumo.core.Specimen

Set the specimen predictand.

setPredictorName(long) - Method in class com.yosokumo.core.Predictor

Set the predictor name.

setSpecimenKey(long) - Method in class com.yosokumo.core.Specimen

Set the specimen key.

setStatus(Predictor.Status) - Method in class com.yosokumo.core.Predictor

Set the predictor status.

setStatus(Specimen.Status) - Method in class com.yosokumo.core.Specimen

Set the specimen status.

setStudyIdentifier(String) - Method in class com.yosokumo.core.Role

Set the study identifier.

setStudyName(String) - Method in class com.yosokumo.core.Role

Set the study name.

setType(Predictor.Type) - Method in class com.yosokumo.core.Predictor

Set the predictor type.

setUserIdentifier(String) - Method in class com.yosokumo.core.Role

Set the user identifier.

setUserName(String) - Method in class com.yosokumo.core.Role

Set the user name.

setWeight(long) - Method in class com.yosokumo.core.Specimen

Set the specimen weight.

size() - Method in class com.yosokumo.core.Catalog

Return the number of studies in the catalog.

size() - Method in class com.yosokumo.core.Roster

Return the number of roles in the roster.

size() - Method in class com.yosokumo.core.Specimen

Return the number of cells in the sequence.

SpecialValue - Class in com.yosokumo.core

Represents an unsigned integer value.

SpecialValue(long) - Constructor for class com.yosokumo.core.SpecialValue

Initialize a newly created SpecialValue object with the value specified by the input parameter.

Specimen - Class in com.yosokumo.core

A row of values.

Specimen(long) - Constructor for class com.yosokumo.core.Specimen

Initializes a newly created Specimen object with key specified by the input parameter.

Specimen(long, Collection<Cell>) - Constructor for class com.yosokumo.core.Specimen

Initializes a newly created Specimen object with key and cell sequence as specified by the input parameters.

Specimen(long, Value, Collection<Cell>) - Constructor for class com.yosokumo.core.Specimen

Initializes a newly created Specimen object with key, predictand, and cell sequence as specified by the input parameters.

Specimen(long, Specimen.Status, long, Value, Collection<Cell>) - Constructor for class com.yosokumo.core.Specimen

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

Specimen.Status - Enum in com.yosokumo.core

Provides a logical delete facility.

Study - Class in com.yosokumo.core

A container for all resources associated with an analytic project.

Study.Status - Enum in com.yosokumo.core

Describes the state of the study, whether it is running, on standby, or stopped.

Study.Type - Enum in com.yosokumo.core

Indicates the quality of the predictands associated with subjects in the study.

Study.Visibility - Enum in com.yosokumo.core

Tells whether unidentified users can get estimated predictands from the model of the study.

T

toString() - Method in class com.yosokumo.core.Catalog

Return a string representation of this Catalog.

toString() - Method in class com.yosokumo.core.Cell

Return a string representation of this Cell.

toString() - Method in class com.yosokumo.core.Credentials

Return a string representation of the Credentials.

toString() - Method in class com.yosokumo.core.EmptyValue

Return the empty value as a String.

toString() - Method in class com.yosokumo.core.IntegerValue

Return the integer value as a String.

toString() - Method in class com.yosokumo.core.Message

Return a string representation of this Message.

toString() - Method in class com.yosokumo.core.NaturalValue

Return the natural value as a String.

toString() - Method in class com.yosokumo.core.Predictor

Return a string representation of this Predictor.

toString() - Method in class com.yosokumo.core.RealValue

Return the real value as a String.

toString() - Method in class com.yosokumo.core.Role

Return a string representation of this Role.

toString() - Method in class com.yosokumo.core.Roster

Return a string representation of this Roster.

toString() - Method in class com.yosokumo.core.SpecialValue

Return the special value as a String.

toString() - Method in class com.yosokumo.core.Specimen

Return a string representation of this Specimen.

toString() - Method in class com.yosokumo.core.Study

Return a string representation of this Study.

toString() - Method in class com.yosokumo.core.Value

Return the value as a String.

U

updateRole(Role) - Method in class com.yosokumo.core.Service

Update a role on the server.

updateStudy(String, String) - Method in class com.yosokumo.core.Service

Update a study, changing the study name.

updateStudy(String, Study.Status) - Method in class com.yosokumo.core.Service

Update a study, changing the status.

updateStudy(String, Study.Visibility) - Method in class com.yosokumo.core.Service

Update a study, changing the visibility.

V

Value - Class in com.yosokumo.core

An abstract base class for value classes which store specific primitive data types, e.g., IntegerValue and RealValue.

Value() - Constructor for class com.yosokumo.core.Value

Value.Type - Enum in com.yosokumo.core

Indicates the data type stored in the Value, e.g., integer or real.

valueOf(String) - Static method in enum com.yosokumo.core.Message.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yosokumo.core.Predictor.Level

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yosokumo.core.Predictor.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yosokumo.core.Predictor.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yosokumo.core.Role.Privilege

Returns the enum constant of this type with the specified name.

valueOf(int) - Static method in enum com.yosokumo.core.Role.Privilege

Convert an integer to a Privilege enum value.

valueOf(String) - Static method in enum com.yosokumo.core.Service.DIFType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yosokumo.core.Specimen.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yosokumo.core.Study.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yosokumo.core.Study.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yosokumo.core.Study.Visibility

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yosokumo.core.Value.Type

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.yosokumo.core.Message.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Predictor.Level

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Predictor.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Predictor.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Role.Privilege

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Service.DIFType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Specimen.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Study.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Study.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Study.Visibility

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yosokumo.core.Value.Type

Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G I K L M N O P R S T U V