water.api.schemas3

Class ValidationMessageV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<ModelBuilder.ValidationMessage,ValidationMessageV3>

water.api.schemas3.ValidationMessageV3

All Implemented Interfaces:

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

public final class ValidationMessageV3
extends SchemaV3<ModelBuilder.ValidationMessage,ValidationMessageV3>

Model builder parameter validation message schema.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.schemas3.SchemaV3

SchemaV3.Meta

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

Schema.AutoParseable

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.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
ValidationMessageV3()

Method Summary

Modifier and Type	Method and Description
ModelBuilder.ValidationMessage	createImpl() Create an appropriate implementation object and any child objects but does not fill them.
ValidationMessageV3	fillFromImpl(ModelBuilder.ValidationMessage vm) Fill this Schema from the given implementation object.
static void	mapValidationMessageFieldNames(ValidationMessageV3[] 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.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillFromParms, fillImpl, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall

Methods inherited from class water.Iced

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

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

ValidationMessageV3

public ValidationMessageV3()

Method Detail

mapValidationMessageFieldNames

public static void mapValidationMessageFieldNames(ValidationMessageV3[] 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 ModelBuilder.ValidationMessage createImpl()

Description copied from class: Schema

Create an appropriate implementation object and any child objects but does not fill them. The standard 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<ModelBuilder.ValidationMessage,ValidationMessageV3>

fillFromImpl

public ValidationMessageV3 fillFromImpl(ModelBuilder.ValidationMessage vm)

Description copied from class: Schema

Fill this Schema from the given implementation object. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

fillFromImpl in class Schema<ModelBuilder.ValidationMessage,ValidationMessageV3>