water.api

Class ValidationMessageBase<I extends ModelBuilder.ValidationMessage,S extends ValidationMessageBase<I,S>>

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.ValidationMessageBase<I,S>

All Implemented Interfaces:

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

Direct Known Subclasses:

ValidationMessageV3

public class ValidationMessageBase<I extends ModelBuilder.ValidationMessage,S extends ValidationMessageBase<I,S>>
extends Schema<I,S>

Model builder parameter validation message schema.

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
java.lang.String	field_name
java.lang.String	message
java.lang.String	message_type

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern, EXCLUDE_FIELDS, INCLUDE_FIELDS

Constructor Summary

Constructors

Constructor and Description
ValidationMessageBase()

Method Summary

Methods

Modifier and Type	Method and Description
I	createImpl() Create an implementation object and any child objects but DO NOT fill them.
S	fillFromImpl(ModelBuilder.ValidationMessage vm) Version and Schema-specific filling from the implementation object.
static void	mapValidationMessageFieldNames(ValidationMessageBase[] validation_messages, 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.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, extractVersion, fillFromParms, fillImpl, getExperimentalVersion, 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_impl, writeHTML, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

message_type

@API(help="Type of validation message (ERROR, WARN, INFO, HIDE)",
     direction=OUTPUT)
public java.lang.String message_type

field_name

@API(help="Field to which the message applies",
     direction=OUTPUT)
public java.lang.String field_name

message

@API(help="Message text",
     direction=OUTPUT)
public java.lang.String message

Constructor Detail

ValidationMessageBase

public ValidationMessageBase()

Method Detail

mapValidationMessageFieldNames

public static void mapValidationMessageFieldNames(ValidationMessageBase[] validation_messages,
                                  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.

createImpl

public I createImpl()

Description copied from class: Schema

Create an implementation object and any child objects but DO NOT fill them. The purpose of a createImpl without a fillImpl is to be able to get the default values for all the impl's fields.

For objects without children this method does all the required work. For objects with children the subclass will need to override, e.g. by calling super.createImpl() and then calling createImpl() on its children.

Note that impl objects for schemas which override this method don't need to have a default constructor (e.g., a Keyed object constructor can still create and set the Key), but they must not fill any fields which can be filled later from the schema.

TODO: We *could* handle the common case of children with the same field names here by finding all of our fields that are themselves Schemas.

Overrides:

createImpl in class Schema<I extends ModelBuilder.ValidationMessage,S extends ValidationMessageBase<I,S>>

fillFromImpl

public S fillFromImpl(ModelBuilder.ValidationMessage vm)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<I extends ModelBuilder.ValidationMessage,S extends ValidationMessageBase<I,S>>