magpie.models.utility

Class MultiModelUtility

java.lang.Object

magpie.models.utility.MultiModelUtility

public abstract class MultiModelUtility
extends java.lang.Object

Contains commands to handle MultiModel operations

Constructor Summary

Constructors

Constructor and Description
MultiModelUtility()

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	handleSubmodelCommand(BaseModel Model, java.util.List<java.lang.Object> Command) Runs commands that are specific to MultiModel-based classes.
static java.lang.String	handleSubmodelPrintCommand(MultiModel Model, java.util.List<java.lang.String> Command) Handles printing commands specific to MultiModels.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiModelUtility

public MultiModelUtility()

Method Detail

handleSubmodelPrintCommand

public static java.lang.String handleSubmodelPrintCommand(MultiModel Model,
                                                          java.util.List<java.lang.String> Command)
                                                   throws java.lang.Exception

Handles printing commands specific to MultiModels. Adds two commands to the printing (copy these to the Javadoc of any class that uses this operation)

submodel - Print out number of submodels

submodel <number> [<command...>] - Pass a print command to one of the submodels
number: Index of model to operate on (starts at 0)
command: Print command that gets passed to that submodel

Parameters:

Model - Model to operate on

Command - Command to parse (should start with "submodel")

Returns:

Product of print command

Throws:

java.lang.Exception - If something goes wrong

handleSubmodelCommand

public static java.lang.Object handleSubmodelCommand(BaseModel Model,
                                                     java.util.List<java.lang.Object> Command)
                                              throws java.lang.Exception

Runs commands that are specific to MultiModel-based classes.

Currently provides the following operations (make sure to copy this into class description):

Implemented Commands:

submodel - Print the number of submodels

submodel set generic $<model> - Define a model template to use for all submodels
model: An instance of BaseModel. Note: Do not use this command for CompositeRegression unless each model automatically uses a different random number seed. Otherwise, each submodel will be identical.

submodel set <number> $<model> - Set a specific submodel
number: Index of the submodel to set (list starts with 0)
model: An instance of BaseModel to use for that model

submodel get generic = <output> - Retrieve the template for any unassigned submodels

submodel get <number> = <output> - Retrieve a specific submodel
number: Index of submodel to retrieve (list starts with 0) Returns a clone of the model - you cannot use this to edit the model.

Parameters:

Model - Model to be operated on

Command - Command to be run (should not start with "submodel")

Returns:

Something of use (depends on command issued)

Throws:

java.lang.Exception