hex.schemas

Class ModelBuilderSchema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>,P extends ModelParametersSchema>

java.lang.Object

water.Iced

water.api.Schema<B,S>

hex.schemas.ModelBuilderSchema<B,S,P>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, SpecifiesHttpResponseCode, Freezable

Direct Known Subclasses:

SupervisedModelBuilderSchema

public abstract class ModelBuilderSchema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>,P extends ModelParametersSchema>
extends Schema<B,S>
implements SpecifiesHttpResponseCode

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.Schema

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
Model.ModelCategory[]	can_build
P	parameters
int	validation_error_count
ModelParametersSchema.ValidationMessageBase[]	validation_messages

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern

Constructor Summary

Constructors

Constructor and Description
ModelBuilderSchema()

Method Summary

Methods

Modifier and Type	Method and Description
B	createImpl() Create the corresponding impl object, as well as its parameters object.
P	createParametersSchema() Factory method to create the model-specific parameters schema.
S	fillFromImpl(B builder) Version and Schema-specific filling from the implementation object.
S	fillFromParms(java.util.Properties parms)
B	fillImpl(B impl) Fill an impl object and any children from this schema and its children.
int	httpStatus()
protected void	mapValidationMessageFieldNames(java.lang.String[] from, java.lang.String[] to) Map impl field names in the validation messages to schema field names, called after behavior of stripping leading _ characters.
void	setHttpStatus(int status)
DocGen.HTML	writeHTML_impl(DocGen.HTML ab) Implementation of the Iced serialization protocol, only called by auto-genned code.
AutoBuffer	writeJSON_impl(AutoBuffer ab) Implementation of the Iced serialization protocol, only called by auto-genned code.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, extractVersion, getHighestSupportedVersion, getImplClass, getImplClass, getLatestVersion, getSchemaVersion, markdown, markdown, markdown, markdown, newInstance, register, registerAllSchemasIfNecessary, schema, schema, schema, schema, schema, schemaClass, schemaClass, schemaClass, schemaClass, schemas

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeHTML, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

parameters

@API(help="Model builder parameters.")
public P extends ModelParametersSchema parameters

can_build

@API(help="Model categories this ModelBuilder can build.",
     direction=OUTPUT)
public Model.ModelCategory[] can_build

validation_messages

@API(help="Parameter validation messages",
     direction=OUTPUT)
public ModelParametersSchema.ValidationMessageBase[] validation_messages

validation_error_count

@API(help="Count of parameter validation errors",
     direction=OUTPUT)
public int validation_error_count

Constructor Detail

ModelBuilderSchema

public ModelBuilderSchema()

Method Detail

setHttpStatus

public void setHttpStatus(int status)

httpStatus

public int httpStatus()

Specified by:

httpStatus in interface SpecifiesHttpResponseCode

createParametersSchema

public final P createParametersSchema()

Factory method to create the model-specific parameters schema.

fillFromParms

public S fillFromParms(java.util.Properties parms)

Overrides:

fillFromParms in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>

createImpl

public final B createImpl()

Create the corresponding impl object, as well as its parameters object.

Overrides:

createImpl in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>

fillImpl

public B fillImpl(B impl)

Description copied from class: Schema

Fill an impl object and any children from this schema and its children.

Overrides:

fillImpl in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>

fillFromImpl

public S fillFromImpl(B builder)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>

mapValidationMessageFieldNames

protected void mapValidationMessageFieldNames(java.lang.String[] from,
                                  java.lang.String[] to)

Map impl field names in the validation messages to schema field names, called after behavior of stripping leading _ characters.

writeHTML_impl

public DocGen.HTML writeHTML_impl(DocGen.HTML ab)

Description copied from class: Iced

Implementation of the Iced serialization protocol, only called by auto-genned code. Not intended to be called by user code. Override only for custom Iced serializers.

Specified by:

writeHTML_impl in interface Freezable

Overrides:

writeHTML_impl in class Iced

Parameters:

ab - html to write object to.

Returns:

Returns the instance of HTML object.

writeJSON_impl

public AutoBuffer writeJSON_impl(AutoBuffer ab)

Description copied from class: Iced

Implementation of the Iced serialization protocol, only called by auto-genned code. Not intended to be called by user code. Override only for custom Iced serializers.

Specified by:

writeJSON_impl in interface Freezable

Overrides:

writeJSON_impl in class Iced

Parameters:

ab - AutoBuffer to write this object to.

Returns:

Returns the original AutoBuffer for flow-coding.