water.api

Class SchemaMetadata.FieldMetadata

java.lang.Object

water.Iced

water.api.SchemaMetadata.FieldMetadata

All Implemented Interfaces:

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

Enclosing class:

SchemaMetadata

public static final class SchemaMetadata.FieldMetadata
extends Iced

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	inherited_from If this field is inherited from a class higher in the hierarchy which one?
boolean	is_gridable Is this field gridable? Set from the @API annotation.
boolean	is_inherited Is this field inherited from a class higher in the hierarchy?
boolean	is_schema Type for this field is itself a Schema.
java.lang.String	name Field name in the POJO.
java.lang.String	schema_name Schema name for this field, if it is_schema.
java.lang.String	type Type for this field.
Iced	value Value for this field.

Constructor Summary

Constructors

Constructor and Description
SchemaMetadata.FieldMetadata()
SchemaMetadata.FieldMetadata(Schema schema, java.lang.reflect.Field f, java.util.List<java.lang.reflect.Field> superclassFields) Create a new FieldMetadata object for the given Field of the given Schema.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	consType(Schema schema, java.lang.Class clz, java.lang.String field_name, API annotation) For a given Class generate a client-friendly type name (e.g., int[][] or Frame).
static Iced	consValue(java.lang.Object o)
static SchemaMetadata.FieldMetadata	createIfApiAnnotation(Schema schema, java.lang.reflect.Field f, java.util.List<java.lang.reflect.Field> superclassFields) Factory method to create a new FieldMetadata instance if the Field has an @API annotation.

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

name

public java.lang.String name

Field name in the POJO. Set through reflection.

type

public java.lang.String type

Type for this field. Set through reflection.

is_schema

public boolean is_schema

Type for this field is itself a Schema. Set through reflection.

schema_name

public java.lang.String schema_name

Schema name for this field, if it is_schema. Set through reflection.

value

public Iced value

Value for this field. Set through reflection.

is_inherited

public boolean is_inherited

Is this field inherited from a class higher in the hierarchy?

inherited_from

public java.lang.String inherited_from

If this field is inherited from a class higher in the hierarchy which one?

is_gridable

public boolean is_gridable

Is this field gridable? Set from the @API annotation.

Constructor Detail

SchemaMetadata.FieldMetadata

public SchemaMetadata.FieldMetadata()

SchemaMetadata.FieldMetadata

public SchemaMetadata.FieldMetadata(Schema schema,
                            java.lang.reflect.Field f,
                            java.util.List<java.lang.reflect.Field> superclassFields)

Create a new FieldMetadata object for the given Field of the given Schema.

Parameters:

schema - water.api.Schema object

f - java.lang.reflect.Field for the Schema class

Method Detail

createIfApiAnnotation

public static SchemaMetadata.FieldMetadata createIfApiAnnotation(Schema schema,
                                                 java.lang.reflect.Field f,
                                                 java.util.List<java.lang.reflect.Field> superclassFields)

Factory method to create a new FieldMetadata instance if the Field has an @API annotation.

Parameters:

schema - water.api.Schema object

f - java.lang.reflect.Field for the Schema class

Returns:

a new FieldMetadata instance if the Field has an @API annotation, else null

consType

public static java.lang.String consType(Schema schema,
                        java.lang.Class clz,
                        java.lang.String field_name,
                        API annotation)

For a given Class generate a client-friendly type name (e.g., int[][] or Frame).

consValue

public static Iced consValue(java.lang.Object o)