water.api

Class SchemaServer

java.lang.Object

water.api.SchemaServer

public class SchemaServer
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SchemaServer()

Method Summary

Modifier and Type	Method and Description
static void	checkIfRegistered(Schema schema)
static int	getExperimentalVersion() Get the experimental schema version, which indicates that a schema is not guaranteed to be stable between H2O releases.
static int	getHighestSupportedVersion() Get the highest schema version that we support.
static int	getLatestOrHighestSupportedVersion() Combines getLatestVersion() and getHighestSupportedVersion().
static int	getLatestVersion() Get the highest schema version number that we've encountered during schema registration.
static java.lang.Class<? extends Schema>	getSchema(java.lang.String name) Lookup schema by name.
static int	getStableVersion()
static void	register(Schema schema) Register the given schema class.
static void	registerAllSchemasIfNecessary(Schema... schemas) Find all schemas using reflection and register them.
static Schema	schema(Iced impl)
static Schema	schema(int version, java.lang.Class<? extends Iced> impl_class) Deprecated.
static Schema	schema(int version, Iced impl) Deprecated.
static java.lang.Class<? extends Schema>	schemaClass(int version, java.lang.String type) Deprecated.
static java.util.Map<java.lang.String,java.lang.Class<? extends Schema>>	schemas() Return an immutable Map of all the schemas: schema_name -> schema Class.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaServer

public SchemaServer()

Method Detail

getLatestVersion

public static int getLatestVersion()

Get the highest schema version number that we've encountered during schema registration.

getHighestSupportedVersion

public static int getHighestSupportedVersion()

Get the highest schema version that we support. This bounds the search for a schema if we haven't yet registered all schemas and don't yet know the latest_version.

getLatestOrHighestSupportedVersion

public static int getLatestOrHighestSupportedVersion()

Combines getLatestVersion() and getHighestSupportedVersion().

getExperimentalVersion

public static int getExperimentalVersion()

Get the experimental schema version, which indicates that a schema is not guaranteed to be stable between H2O releases.

getStableVersion

public static int getStableVersion()

checkIfRegistered

public static void checkIfRegistered(Schema schema)

register

public static void register(Schema schema)

Register the given schema class.

Throws:

H2OFailException - if there is a name collision, if the type parameters are bad, or if the version is bad

registerAllSchemasIfNecessary

public static void registerAllSchemasIfNecessary(Schema... schemas)

Find all schemas using reflection and register them.

schemas

public static java.util.Map<java.lang.String,java.lang.Class<? extends Schema>> schemas()

Return an immutable Map of all the schemas: schema_name -> schema Class.

getSchema

public static java.lang.Class<? extends Schema> getSchema(java.lang.String name)

Lookup schema by name.

Throws:

H2ONotFoundArgumentException - if an appropriate schema is not found

schemaClass

public static java.lang.Class<? extends Schema> schemaClass(int version,
                                                            java.lang.String type)

Deprecated.

For a given version and type (Iced class simpleName) return the appropriate Schema class, if any.

If a higher version is asked for than is available (e.g., if the highest version of Frame is FrameV2 and the client asks for the schema for (Frame, 17) then FrameV2 will be returned. This compatibility lookup is cached.

schema

public static Schema schema(int version,
                            Iced impl)

Deprecated.

For a given version and Iced object return an appropriate Schema instance, if any.

See Also:

schema(int, java.lang.String)

schema

public static Schema schema(Iced impl)

schema

public static Schema schema(int version,
                            java.lang.Class<? extends Iced> impl_class)

Deprecated.

For a given version and Iced class return an appropriate Schema instance, if any.

Parameters:

version - Version of the schema to create, or pass -1 to use the latest version.

impl_class - Create schema corresponds to this implementation class.

Throws:

H2OIllegalArgumentException - if Class.newInstance() throws

See Also:

schema(int, java.lang.String)