hex.createframe

Class CreateFrameRecipe<T extends CreateFrameRecipe<T>>

java.lang.Object

water.Iced<T>

hex.createframe.CreateFrameRecipe<T>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<T>

Direct Known Subclasses:

OriginalCreateFrameRecipe, SimpleCreateFrameRecipe

public abstract class CreateFrameRecipe<T extends CreateFrameRecipe<T>>
extends Iced<T>

Base class for all frame creation recipes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Key<Frame>	dest
long	seed

Constructor Summary

Constructors

Constructor and Description
CreateFrameRecipe()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	buildRecipe(CreateFrameExecutor cfe) Set up the provided CreateFrameExecutor so that it knows how to construct the frame corresponding to the recipe being built.
protected void	check(boolean test, java.lang.String msg) Simple helper function for parameter testing.
protected abstract void	checkParametersValidity() Test whether the input parameters are valid, and throw error if they aren't.
protected void	checkParametersValidity2(CreateFrameExecutor cfe) Final step of parameter testing, after the CreateFrameExecutor has been set up, but just before the actual frame creation commences.
Job<Frame>	exec() This function will be called by the REST API handler to initiate making of the recipe.
protected void	fillMissingParameters() Resolve parameter values that cannot be initialized to static defaults.

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

dest

public Key<Frame> dest

seed

public long seed

Constructor Detail

CreateFrameRecipe

public CreateFrameRecipe()

Method Detail

checkParametersValidity

protected abstract void checkParametersValidity()

Test whether the input parameters are valid, and throw error if they aren't. You may use the check(boolean, String) helper function to make this somewhat easier.

buildRecipe

protected abstract void buildRecipe(CreateFrameExecutor cfe)

Set up the provided CreateFrameExecutor so that it knows how to construct the frame corresponding to the recipe being built.

exec

public Job<Frame> exec()

This function will be called by the REST API handler to initiate making of the recipe. It returns a Job which will hold the created frame once it is finished.

fillMissingParameters

protected void fillMissingParameters()

Resolve parameter values that cannot be initialized to static defaults. If you're overriding this method, please make sure to invoke the super implementation as well.

checkParametersValidity2

protected void checkParametersValidity2(CreateFrameExecutor cfe)

Final step of parameter testing, after the CreateFrameExecutor has been set up, but just before the actual frame creation commences. This method shall only be used to perform checks that cannot be done without the CreateFrameExecutor instance.

check

protected void check(boolean test,
         java.lang.String msg)

Simple helper function for parameter testing.