Package org.apache.flink.table.factories

Class FactoryUtil.DefaultModelProviderContext

java.lang.Object

org.apache.flink.table.factories.FactoryUtil.DefaultModelProviderContext

All Implemented Interfaces:

ModelProviderFactory.Context

Enclosing class:

FactoryUtil

@Internal
public static class FactoryUtil.DefaultModelProviderContext
extends Object
implements ModelProviderFactory.Context

Default implementation of ModelProviderFactory.Context.

Constructor Summary

Constructors

Constructor	Description
DefaultModelProviderContext(ObjectIdentifier objectIdentifier, ResolvedCatalogModel catalogModel, org.apache.flink.configuration.ReadableConfig configuration, ClassLoader classLoader, boolean isTemporary)

Method Summary

Modifier and Type	Method	Description
ResolvedCatalogModel	getCatalogModel()	Returns the resolved model information received from the Catalog or persisted plan.
ClassLoader	getClassLoader()	Returns the class loader of the current session.
org.apache.flink.configuration.ReadableConfig	getConfiguration()	Gives read-only access to the configuration of the current session.
ObjectIdentifier	getObjectIdentifier()	Returns the identifier of the model in the Catalog.
boolean	isTemporary()	Whether the model is temporary.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultModelProviderContext

public DefaultModelProviderContext(ObjectIdentifier objectIdentifier,
                                   ResolvedCatalogModel catalogModel,
                                   org.apache.flink.configuration.ReadableConfig configuration,
                                   ClassLoader classLoader,
                                   boolean isTemporary)

Method Detail

getObjectIdentifier

public ObjectIdentifier getObjectIdentifier()

Description copied from interface: ModelProviderFactory.Context

Returns the identifier of the model in the Catalog.

This identifier describes the relationship between the model instance and the associated Catalog (if any).

Specified by:

getObjectIdentifier in interface ModelProviderFactory.Context

getCatalogModel

public ResolvedCatalogModel getCatalogModel()

Description copied from interface: ModelProviderFactory.Context

Returns the resolved model information received from the Catalog or persisted plan.

The ResolvedCatalogModel forwards the metadata from the catalog but offers a validated ResolvedSchema. The original metadata object is available via ResolvedCatalogModel.getOrigin().

In most cases, a factory is interested in the following characteristics:

 // get the physical input and output data type to initialize the connector
 context.getCatalogModel().getResolvedInputSchema().toPhysicalRowDataType()
 context.getCatalogModel().getResolvedInputSchema().toPhysicalRowDataType()

 // get configuration options
 context.getCatalogModel().getOptions()
 

During a plan restore, usually the model information persisted in the plan is used to reconstruct the catalog model.

Specified by:

getCatalogModel in interface ModelProviderFactory.Context

getConfiguration

public org.apache.flink.configuration.ReadableConfig getConfiguration()

Description copied from interface: ModelProviderFactory.Context

Gives read-only access to the configuration of the current session.

Specified by:

getConfiguration in interface ModelProviderFactory.Context

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: ModelProviderFactory.Context

Returns the class loader of the current session.

The class loader is in particular useful for discovering further (nested) factories.

Specified by:

getClassLoader in interface ModelProviderFactory.Context

isTemporary

public boolean isTemporary()

Description copied from interface: ModelProviderFactory.Context

Whether the model is temporary.

Specified by:

isTemporary in interface ModelProviderFactory.Context