org.kitesdk.data.spi

Class Compatibility

java.lang.Object

org.kitesdk.data.spi.Compatibility

public abstract class Compatibility
extends Object

Methods for checking compatibility.

Constructor Summary

Constructors

Constructor and Description
Compatibility()

Method Summary

Methods

Modifier and Type	Method and Description
static void	check(String namespace, String name, DatasetDescriptor descriptor) Checks the name and descriptor for known compatibility issues and throws an exception if an incompatibility is found.
static void	checkAndWarn(String namespace, String datasetName, Schema schema) Checks the name and schema for known compatibility issues and warns.
static void	checkCompatible(DatasetDescriptor existing, DatasetDescriptor test) Checks that the existing DatasetDescriptor is compatible with test.
static void	checkDatasetName(String namespace, String name) Precondition-style validation that a dataset name is compatible.
static void	checkDescriptor(DatasetDescriptor descriptor) Precondition-style validation that the DatasetDescriptor is compatible.
static void	checkSchema(Schema schema) Precondition-style validation that a Schema is compatible.
static void	checkStrategyUpdate(PartitionStrategy existing, PartitionStrategy other, Schema schema)
static void	checkUpdate(DatasetDescriptor existing, DatasetDescriptor updated) Checks that the existing DatasetDescriptor can be replaced by updated.
static boolean	isAvroCompatibleName(String name) Returns true if the name does not contain characters that are known to be incompatible with the specs defined in Avro schema.
static boolean	isCompatibleName(String name) Returns true if the name does not contain characters that are known to be incompatible with some projects, such as Hive or HBase.

Methods inherited from class java.lang.Object

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

Constructor Detail

Compatibility

public Compatibility()

Method Detail

check

public static void check(String namespace,
         String name,
         DatasetDescriptor descriptor)

Checks the name and descriptor for known compatibility issues and throws an exception if an incompatibility is found. If the column names are not compatible across components or if any partition name duplicates its source field name, this will cause an error.

Parameters:

namespace - a String namespace

name - a String dataset name

descriptor - a DatasetDescriptor

checkAndWarn

public static void checkAndWarn(String namespace,
                String datasetName,
                Schema schema)

Checks the name and schema for known compatibility issues and warns. If the column names are not compatible across components, this will warn the user.

Parameters:

namespace - a String namespace

datasetName - a String dataset name

schema - a Schema

checkDatasetName

public static void checkDatasetName(String namespace,
                    String name)

Precondition-style validation that a dataset name is compatible.

Parameters:

namespace - a String namespace

name - a String name

checkSchema

public static void checkSchema(Schema schema)

Precondition-style validation that a Schema is compatible.

Parameters:

schema - an avro Schema

checkDescriptor

public static void checkDescriptor(DatasetDescriptor descriptor)

Precondition-style validation that the DatasetDescriptor is compatible.

Parameters:

descriptor - a DatasetDescriptor

isCompatibleName

public static boolean isCompatibleName(String name)

Returns true if the name does not contain characters that are known to be incompatible with some projects, such as Hive or HBase.

Parameters:

name - a String name to check

Returns:

true if the name is compatible, false if known to be incompatible

isAvroCompatibleName

public static boolean isAvroCompatibleName(String name)

Returns true if the name does not contain characters that are known to be incompatible with the specs defined in Avro schema.

Parameters:

name - a String field name to check

Returns:

will return true if the name is Avro compatible ,false if not

checkUpdate

public static void checkUpdate(DatasetDescriptor existing,
               DatasetDescriptor updated)

Checks that the existing DatasetDescriptor can be replaced by updated.

Parameters:

existing - the current DatasetDescriptor for a dataset

updated - a new DatasetDescriptor for the same dataset

checkCompatible

public static void checkCompatible(DatasetDescriptor existing,
                   DatasetDescriptor test)

Checks that the existing DatasetDescriptor is compatible with test.

Parameters:

existing - the current DatasetDescriptor for a dataset

test - a new DatasetDescriptor for the same dataset

checkStrategyUpdate

public static void checkStrategyUpdate(PartitionStrategy existing,
                       PartitionStrategy other,
                       Schema schema)