io.cdap.common.internal.io

Class AbstractSchemaGenerator

java.lang.Object

io.cdap.common.internal.io.AbstractSchemaGenerator

All Implemented Interfaces:

SchemaGenerator

Direct Known Subclasses:

ReflectionSchemaGenerator

public abstract class AbstractSchemaGenerator
extends Object
implements SchemaGenerator

An abstract base class for generating schema. It knows how to generate most of the supported data type, except record (bean class) type, which it delegates to child class.

Constructor Summary

Constructors

Constructor and Description
AbstractSchemaGenerator()

Method Summary

Modifier and Type	Method and Description
protected Schema	doGenerate(com.google.common.reflect.TypeToken<?> typeToken, Set<String> knownRecords, boolean acceptRecursion) Actual schema generation.
Schema	generate(Type type) Generate a Schema for the given java Type.
Schema	generate(Type type, boolean acceptRecursiveTypes) Generate a Schema for the given java Type.
protected abstract Schema	generateRecord(com.google.common.reflect.TypeToken<?> typeToken, Set<String> knownRecords, boolean acceptRecursiveTypes) Generates a RECORD schema of the given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSchemaGenerator

public AbstractSchemaGenerator()

Method Detail

generate

public final Schema generate(Type type)
                      throws UnsupportedTypeException

Description copied from interface: SchemaGenerator

Generate a Schema for the given java Type.

Specified by:

generate in interface SchemaGenerator

Parameters:

type - The java Type for generating a Schema.

Returns:

A Schema representing the given java Type.

Throws:

UnsupportedTypeException - Indicates schema generation is not supported for the given java Type.

generate

public final Schema generate(Type type,
                             boolean acceptRecursiveTypes)
                      throws UnsupportedTypeException

Description copied from interface: SchemaGenerator

Generate a Schema for the given java Type.

Specified by:

generate in interface SchemaGenerator

Parameters:

type - The java Type for generating a Schema.

acceptRecursiveTypes - Whether to tolerate type recursion. If false, will throw UnsupportedTypeException if a recursive type is encountered.

Returns:

A Schema representing the given java Type.

Throws:

UnsupportedTypeException - Indicates schema generation is not supported for the given java Type.

doGenerate

protected final Schema doGenerate(com.google.common.reflect.TypeToken<?> typeToken,
                                  Set<String> knownRecords,
                                  boolean acceptRecursion)
                           throws UnsupportedTypeException

Actual schema generation. It recursively resolves container types.

Parameters:

typeToken - Encapsulate the Java type for generating a Schema.

knownRecords - Set of record names that has the schema already generated. It is used for recursive class field references.

acceptRecursion - Whether to tolerate type recursion. If false, will throw UnsupportedTypeException if a recursive type is encountered.

Returns:

A Schema representing the given java Type.

Throws:

UnsupportedTypeException - Indicates schema generation is not support for the given java Type.

generateRecord

protected abstract Schema generateRecord(com.google.common.reflect.TypeToken<?> typeToken,
                                         Set<String> knownRecords,
                                         boolean acceptRecursiveTypes)
                                  throws UnsupportedTypeException

Generates a RECORD schema of the given type.

Parameters:

typeToken - Type of the record.

knownRecords - Set of record names that schema has already been generated.

acceptRecursiveTypes - Whether to tolerate type recursion. If false, will throw UnsupportedTypeException if a recursive type is encountered.

Returns:

An instance of Schema

Throws:

UnsupportedTypeException