org.apache.flink.table.descriptors

Class FormatDescriptor

java.lang.Object

org.apache.flink.table.descriptors.DescriptorBase

org.apache.flink.table.descriptors.FormatDescriptor

All Implemented Interfaces:

Descriptor

Direct Known Subclasses:

Avro, Csv, CustomFormatDescriptor, Json, OldCsv

@PublicEvolving
public abstract class FormatDescriptor
extends DescriptorBase
implements Descriptor

Describes the format of data.

Constructor Summary

Constructors

Constructor and Description
FormatDescriptor(String type, int version) Constructs a FormatDescriptor.

Method Summary

Modifier and Type	Method and Description
protected abstract Map<String,String>	toFormatProperties() Converts this descriptor into a set of format properties.
Map<String,String>	toProperties() Converts this descriptor into a set of properties.

Methods inherited from class org.apache.flink.table.descriptors.DescriptorBase

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatDescriptor

public FormatDescriptor(String type,
                        int version)

Constructs a FormatDescriptor.

Parameters:

type - string that identifies this format

version - property version for backwards compatibility

Method Detail

toProperties

public final Map<String,String> toProperties()

Description copied from interface: Descriptor

Converts this descriptor into a set of properties.

Specified by:

toProperties in interface Descriptor

toFormatProperties

protected abstract Map<String,String> toFormatProperties()

Converts this descriptor into a set of format properties. Usually prefixed with FormatDescriptorValidator.FORMAT.