io.capsisBridgeClient

Class AbstractCapsisBridgeClient

java.lang.Object

io.capsisBridgeClient.AbstractCapsisBridgeClient

Direct Known Subclasses:

CapsisBridgeClientDirect, CapsisBridgeClientGrpc

public abstract class AbstractCapsisBridgeClient
extends java.lang.Object

This class abstracts the CapsisBridgeClient to allow gRPC mode and direct mode interfacing to Capsis. The gRPC client will send RPC requests over the channel to the gRPC service, whereas the direct client will directly call Capsis methods in the same process and thread.

Since:

2020-12-22

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractCapsisBridgeClient.TestHelper Only used for helping unit test.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractCapsisBridgeClient.TestHelper	testHelper

Constructor Summary

Constructors

Constructor and Description
AbstractCapsisBridgeClient()

Method Summary

Modifier and Type	Method and Description
abstract void	addSimulationResult(java.lang.String stratumGroup, int initialAgeYr, CBSimulationResult result) Adds a simulation result to the MetaModelManager
abstract void	closeProject() Closes the project
abstract void	fitMetaModels() Fits the metamodels on the previously given simulation results for all StratumGroupIDs.
abstract void	freeAndReportMemory() Debug only method : calls GC and reports used memory.
abstract CBDataSet	getMetaModelResult(java.lang.String stratumGroup) Gets the fitted metamodel simulation results
abstract java.util.List<CBModelDataField>	getModelDataFields() Gets the model data fields
abstract java.util.List<java.lang.String>	getPossibleOutputTypes(java.lang.String stratumGroup) Gets the metamodel possible output types.
abstract double	getPrediction(java.lang.String stratumGroup, int ageYr, int timeSinceInitialDateYr, java.lang.String outputType) Gets a metamodel prediction for a particular stratumGroup
abstract java.util.Map<java.lang.String,java.lang.String>	getVersion() Gets the CAPSIS and bridge versions
static void	info(java.lang.String msg, java.lang.Object... params) Utility method.
abstract void	load(java.lang.String fileName) Loads a metamodel to a file
abstract CBSimulationResult	runSimulation() Runs the simulation using the given initialParameters, evolutionParameters and data.
abstract void	save(java.lang.String fileName) Saves a metamodel to a file
abstract void	sendData(java.util.ArrayList<java.util.List<java.lang.String>> data) Sends the model data
abstract void	setEvolutionParameters(CBEvolutionParameters evolutionParameters) Sets the evolution parameters
abstract void	setFieldMatches(java.lang.Integer[] matches) Sets the field matches
abstract void	setInitialModelParameters(CBModelParameters modelParameters) Sets the initial model parameters
void	setTestHelper(AbstractCapsisBridgeClient.TestHelper testHelper) Only used for helping unit test.
abstract void	shutDownNow() Stops the corresponding service now.
static void	warning(java.lang.String msg, java.lang.Object... params) Utility method.

Methods inherited from class java.lang.Object

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

Field Detail

testHelper

protected AbstractCapsisBridgeClient.TestHelper testHelper

Constructor Detail

AbstractCapsisBridgeClient

public AbstractCapsisBridgeClient()

Method Detail

getModelDataFields

public abstract java.util.List<CBModelDataField> getModelDataFields()
                                                             throws java.lang.RuntimeException

Gets the model data fields

Returns:

ModelDataFields as ordered list of (type, name) pairs in the specific order expected by the Capsis model.

Throws:

java.lang.RuntimeException

setInitialModelParameters

public abstract void setInitialModelParameters(CBModelParameters modelParameters)
                                        throws java.lang.RuntimeException

Sets the initial model parameters

Parameters:

modelParameters - the initial model parameters to set.

Throws:

java.lang.RuntimeException

setFieldMatches

public abstract void setFieldMatches(java.lang.Integer[] matches)
                              throws java.lang.RuntimeException

Sets the field matches

Parameters:

matches - the field matches array specifying the field index order.

Throws:

java.lang.RuntimeException

setEvolutionParameters

public abstract void setEvolutionParameters(CBEvolutionParameters evolutionParameters)
                                     throws java.lang.RuntimeException

Sets the evolution parameters

Parameters:

evolutionParameters - the evolution parameters to set.

Throws:

java.lang.RuntimeException

runSimulation

public abstract CBSimulationResult runSimulation()
                                          throws java.lang.RuntimeException

Runs the simulation using the given initialParameters, evolutionParameters and data.

Returns:

Throws:

java.lang.RuntimeException

sendData

public abstract void sendData(java.util.ArrayList<java.util.List<java.lang.String>> data)
                       throws java.lang.RuntimeException

Sends the model data

Parameters:

data - the model data to send to Capsis (represented in an arrayList of Lists of string values).

Throws:

java.lang.RuntimeException

closeProject

public abstract void closeProject()
                           throws java.lang.RuntimeException

Closes the project

Throws:

java.lang.RuntimeException

freeAndReportMemory

public abstract void freeAndReportMemory()
                                  throws java.lang.RuntimeException

Debug only method : calls GC and reports used memory. Mainly used for memory monitoring if needed.

Throws:

java.lang.RuntimeException

getVersion

public abstract java.util.Map<java.lang.String,java.lang.String> getVersion()
                                                                     throws java.lang.RuntimeException

Gets the CAPSIS and bridge versions

Returns:

The CAPSIS engine and bridge versions as separate strings into a map with keys ["Capsis", "Bridge]

Throws:

java.lang.RuntimeException

addSimulationResult

public abstract void addSimulationResult(java.lang.String stratumGroup,
                                         int initialAgeYr,
                                         CBSimulationResult result)
                                  throws java.lang.RuntimeException

Adds a simulation result to the MetaModelManager

Parameters:

stratumGroup - The stratum group id to add the simulation results to

initialAgeYr - The initial age year of this stratum group

result - The simulations results (given by getSimulationResult)

Throws:

java.lang.RuntimeException

fitMetaModels

public abstract void fitMetaModels()
                            throws java.lang.RuntimeException

Fits the metamodels on the previously given simulation results for all StratumGroupIDs.

Throws:

java.lang.RuntimeException

getPossibleOutputTypes

public abstract java.util.List<java.lang.String> getPossibleOutputTypes(java.lang.String stratumGroup)
                                                                 throws java.lang.RuntimeException

Gets the metamodel possible output types. fitMetaModels() must have been called before calling this method and it should be used to query the possible outputTypes needed in getPrediction() calls.

Parameters:

stratumGroup - The stratumGroup for which we want the possible output types.

Returns:

The possible output types.

Throws:

java.lang.RuntimeException

See Also:

fitMetaModels(), getPrediction(String, int, int, String)

getPrediction

public abstract double getPrediction(java.lang.String stratumGroup,
                                     int ageYr,
                                     int timeSinceInitialDateYr,
                                     java.lang.String outputType)
                              throws java.lang.RuntimeException

Gets a metamodel prediction for a particular stratumGroup

Parameters:

stratumGroup - The stratum group ID

ageYr - the age of the desired prediction

timeSinceInitialDateYr - The number of years elapsed since initialDateYear for ageYr

outputType - A string specifying the desired output. This value must be taken from the SimulationResult.DataSet.Observation values.

Returns:

Volume prediction computed from the metamodel

Throws:

java.lang.RuntimeException

getMetaModelResult

public abstract CBDataSet getMetaModelResult(java.lang.String stratumGroup)
                                      throws java.lang.RuntimeException

Gets the fitted metamodel simulation results

Parameters:

stratumGroup - The stratum group ID

Returns:

Fitted dataset results

Throws:

java.lang.RuntimeException

save

public abstract void save(java.lang.String fileName)
                   throws java.lang.RuntimeException

Saves a metamodel to a file

Parameters:

fileName - The filename to save the metamodel to

Throws:

java.lang.RuntimeException

load

public abstract void load(java.lang.String fileName)
                   throws java.lang.RuntimeException

Loads a metamodel to a file

Parameters:

fileName - The filename to load the metamodel from

Throws:

java.lang.RuntimeException

shutDownNow

public abstract void shutDownNow()

Stops the corresponding service now. Only useful in gRPC mode when the client code needs to immediately shut down the gRPC service.

info

public static void info(java.lang.String msg,
                        java.lang.Object... params)

Utility method. Outputs an INFO log trace to the logger

Parameters:

msg - The message to log

params - any other params

warning

public static void warning(java.lang.String msg,
                           java.lang.Object... params)

Utility method. Outputs a WARNING log trace to the logger

Parameters:

msg - The message to log

params - any other params

setTestHelper

public void setTestHelper(AbstractCapsisBridgeClient.TestHelper testHelper)

Only used for helping unit test.