Skip navigation links

com.sigmadynamics.sdo.interfaces
Interface ApplicationInterface

All Superinterfaces:

SDOInterface

All Known Implementing Classes:

ApplicationBase, SDApplicationBase

public interface ApplicationInterface

extends SDOInterface

Implemented by the main class of an Inline Service.

Since:

1.0

Method Summary

void	cleanUp()
void	deleteChoiceHistory()
void	deleteStatistics()
boolean	deleteStudy() Deletes the study of the Inline Service containing the calling BatchJob, together with all its contained learning models and associated prediction models.
boolean	determineCG()
int	dumpStudy(boolean rewriteCompletedTimeWindows) Creates a snapshot of the study that is owned by the Inline Service containing the calling BatchJob.
int	dumpStudy(boolean rewriteCompletedTimeWindows, float minAbsCorrelation, int numberOfBins) Creates a snapshot of the study that is owned by the Inline Service containing the calling BatchJob.
void	flushStatistics()
void	forceLearning() Updates the in-memory learning models of all studies to include the latest available learnings, and persists the updated learning models to the database.
com.sigmadynamics.batch.BatchAgent	getBatchAgent()
ChoiceGroupInterface	getChoiceGroup(java.lang.String groupId)
int	getDataVersion()
ChoiceArrayInterface	getDefaultChoices()
int	getDeploymentState()
int	getDeploymentVersion()
Metadata	getMetadata()
java.lang.String	getName() Gets the application name.
int	getSessionCount()
java.lang.String	getStudyName() Get the application's study name.
void	init()
boolean	isStoppedOrShuttingDown()
void	rebuildPredictionModels() Rebuilds prediction models for all studies, so they include all recent learnings.

Methods inherited from interface com.sigmadynamics.sdo.interfaces.client.SDOInterface

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId

Method Detail

getName

java.lang.String getName()

Gets the application name.

Returns:

application name

getStudyName

java.lang.String getStudyName()

Get the application's study name.

Since:

3.0

rebuildPredictionModels

void rebuildPredictionModels()

Rebuilds prediction models for all studies, so they include all recent learnings.

This method asks the Learning Service to do the following sequence of activities, and returns after the sequence has finished.

1. Process all previously unprocessed learning records, by reading them from the database and updating the in-memory learning models to reflect the knowledge encapsulated by the learning records.
2. Persist the newly updated learning models to the database, for all studies.
3. Rebuild all prediction models for all studies.
4. Persist the new prediction models to the database.
5. Wait for the new prediction models to be loaded into memory, where they will be available for making predictions.

Since:

11.1.1.5.0

forceLearning

void forceLearning()

Updates the in-memory learning models of all studies to include the latest available learnings, and persists the updated learning models to the database.

Since:

11.1.1.5.0

deleteStudy

boolean deleteStudy()

Deletes the study of the Inline Service containing the calling BatchJob, together with all its contained learning models and associated prediction models.

Since:

11.1.1.5.0

dumpStudy

int dumpStudy(boolean rewriteCompletedTimeWindows)

Creates a snapshot of the study that is owned by the Inline Service containing the calling BatchJob.

Because this operation could take a long time to execute, the recommended practice is to call it directly from a batch job, or from an Integration Point that was invoked by a batch job. Calling it from an Integration Point that was invoked by a Decision Service web service client would likely cause the web service call to timeout.

This call uses the default tuning attributes, meaning it behaves the same as calling

int dumpStudy(boolean rewriteCompletedTimeWindows, double minAbsCorrelation, int numberOfBins);

with the minAbsCorrelation and numberOfBins parameters set to the values seen in the JMX MBean attributes, ModelSnapshotMinAbsCorrelation (default=.000001) and ModelSnapshotNumberOfBins (default=5), respectively. Refer to the RTD installation guide for information about accessing these MBean attributes.

Parameters:

rewriteCompletedTimeWindows - If true, the snapshot data for completed time windows will be deleted and recreated, even though their contents should not have changed.

Since:

11.1.1.5.0

dumpStudy

int dumpStudy(boolean rewriteCompletedTimeWindows,
              float minAbsCorrelation,
              int numberOfBins)

Creates a snapshot of the study that is owned by the Inline Service containing the calling BatchJob.

Because this operation could take a long time to execute, the recommended practice is to call it directly from a batch job, or from an Integration Point that was invoked by a batch job. Calling it from an Integration Point that was invoked by a Decision Service web service client would likely cause the web service call to timeout.

Parameters:

rewriteCompletedTimeWindows - If true, the snapshot data for completed time windows will be deleted and recreated, even though their contents would not have changed.

minAbsCorrelation - Minimum allowed absolute correlation value permitted in model snapshots. Use 0 for all, but be prepared for a lot of data.

numberOfBins - A hint to the Learning Service for the preferred number of bins to use when writing numeric attribute values to a model snapshot.

Since:

11.1.1.5.0

isStoppedOrShuttingDown

boolean isStoppedOrShuttingDown()

Returns:

true if the app is stopped or in the process of shutting down

getDeploymentVersion

int getDeploymentVersion()

getDataVersion

int getDataVersion()

cleanUp

void cleanUp()

init

void init()

getDefaultChoices

ChoiceArrayInterface getDefaultChoices()

flushStatistics

void flushStatistics()

getMetadata

Metadata getMetadata()

getSessionCount

int getSessionCount()

determineCG

boolean determineCG()

deleteStatistics

void deleteStatistics()

getDeploymentState

int getDeploymentState()

deleteChoiceHistory

void deleteChoiceHistory()

getChoiceGroup

ChoiceGroupInterface getChoiceGroup(java.lang.String groupId)

getBatchAgent

com.sigmadynamics.batch.BatchAgent getBatchAgent()

Since:

3.0

Skip navigation links