org.apache.flink.table.factories

Interface ComponentFactory

All Superinterfaces:

org.apache.flink.table.factories.TableFactory

All Known Subinterfaces:

ExecutorFactory, PlannerFactory

@PublicEvolving
public interface ComponentFactory
extends org.apache.flink.table.factories.TableFactory

A factory interface for components that enables further disambiguating in case there are multiple matching implementations present.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	optionalContext() Specifies a context of optional parameters that if exist should have the given values.
Map<String,String>	requiredContext()
List<String>	supportedProperties()

Method Detail

optionalContext

Map<String,String> optionalContext()

Specifies a context of optional parameters that if exist should have the given values. This enables further disambiguating if there are multiple factories that meet the requiredContext() and supportedProperties().

NOTE: All the property keys should be included in supportedProperties().

Returns:

optional properties to disambiguate factories

requiredContext

Map<String,String> requiredContext()

Specified by:

requiredContext in interface org.apache.flink.table.factories.TableFactory

supportedProperties

List<String> supportedProperties()

NOTE: All the property keys from optionalContext() should also be included.

Specified by:

supportedProperties in interface org.apache.flink.table.factories.TableFactory