Package org.apache.wayang.core.plugin

Interface Plugin

All Known Implementing Classes:

DynamicPlugin, FlinkBasicPlugin, FlinkConversionPlugin, GenericJdbcConversionsPlugin, GenericJdbcPlugin, GiraphPlugin, JavaBasicPlugin, JavaChannelConversionPlugin, JavaGraphPlugin, PostgresConversionsPlugin, PostgresPlugin, SparkBasicPlugin, SparkConversionPlugin, SparkGraphPlugin, SparkMLPlugin, Sqlite3ConversionPlugin, Sqlite3Plugin, TensorflowConversionPlugin, TensorflowPlugin, WayangBasic, WayangBasicGraph

public interface Plugin

A plugin contributes the following components to a WayangContext:

• Mappings,
• ChannelConversions, and
• Configuration properties.

In turn, it may require several Platforms for its operation.

Method Summary

Modifier and Type	Method	Description
default void	configure(Configuration configuration)	Configures the Configuration, thereby registering the components of this instance.
Collection<ChannelConversion>	getChannelConversions()	Provides the ChannelConversions shipped with this instance.
default Collection<ChannelConversion>	getExcludedChannelConversions()	Provides the ChannelConversions excluded by this instance.
default Collection<Mapping>	getExcludedMappings()	Provides the Mappings excluded by this instance.
default Collection<Platform>	getExcludedRequiredPlatforms()	Provides the required Platforms excluded by this instance.
Collection<Mapping>	getMappings()	Provides the Mappings shipped with this instance.
Collection<Platform>	getRequiredPlatforms()	Provides the Platforms required by this instance.
void	setProperties(Configuration configuration)	Provides relevant Configuration properties.

Method Details

configure

default void configure(Configuration configuration)

Configures the Configuration, thereby registering the components of this instance.

Parameters:

configuration - that should be configured

getRequiredPlatforms

Collection<Platform> getRequiredPlatforms()

Provides the Platforms required by this instance.

Returns:

the Platforms

getExcludedRequiredPlatforms

default Collection<Platform> getExcludedRequiredPlatforms()

Provides the required Platforms excluded by this instance.

Returns:

the Platforms

getMappings

Collection<Mapping> getMappings()

Provides the Mappings shipped with this instance.

Returns:

the Mappings

getExcludedMappings

default Collection<Mapping> getExcludedMappings()

Provides the Mappings excluded by this instance.

Returns:

the Mappings

getChannelConversions

Collection<ChannelConversion> getChannelConversions()

Provides the ChannelConversions shipped with this instance.

Returns:

the ChannelConversions

getExcludedChannelConversions

default Collection<ChannelConversion> getExcludedChannelConversions()

Provides the ChannelConversions excluded by this instance.

Returns:

the ChannelConversions

setProperties

void setProperties(Configuration configuration)

Provides relevant Configuration properties.

Parameters:

configuration - accepts the properties