Package org.aksw.faraday_cage

Interface Parametrized

All Known Subinterfaces:

ParametrizedDeerPlugin, ParametrizedNode<T>

All Known Implementing Classes:

AbstractModelIO, AbstractModelReader, AbstractModelWriter, AbstractParametrizedEnrichmentOperator, AbstractParametrizedNode, AbstractParametrizedNode.WithImplicitCloning, AuthorityConformationEnrichmentOperator, DefaultModelReader, DefaultModelWriter, DereferencingEnrichmentOperator, FilterEnrichmentOperator, GeoDistanceEnrichmentOperator, GeoFusionEnrichmentOperator, LinkingEnrichmentOperator, NEREnrichmentOperator, PredicateConformationEnrichmentOperator

public interface Parametrized

Base interface for parametrized plugins, defines a contract.

A ParametrizedPlugin is a class that is parametrized using a ParameterMap.
It should only be instantiated from instances of PluginFactory. For this to work, each plugin type needs to define a plugin type interface that extends at least ParametrizedPlugin and ExtensionPoint. Furthermore, each non-abstract class implementing a plugin type interface should be annotated with Extension.

Method Summary

Modifier and Type	Method	Description
ParameterMap	createParameterMap()	Create an uninitialized ParameterMap to be filled by the ExecutionGraphGenerator.
ParameterMap	getParameterMap()	Get this instances configuration as an initialized ParameterMap.
void	init(ParameterMap parameterMap)	Accept an initialized ParameterMap in order to configure this instance.
boolean	isInitialized()	Get initialization status

Method Detail

createParameterMap

@NotNull
ParameterMap createParameterMap()

Create an uninitialized ParameterMap to be filled by the ExecutionGraphGenerator.

Returns:

uninitialized ParameterMap containing all allowed Parameter

init

void init(@NotNull
          ParameterMap parameterMap)

Accept an initialized ParameterMap in order to configure this instance.

Parameters:

parameterMap - an initialized ParameterMap

getParameterMap

@NotNull
ParameterMap getParameterMap()

Get this instances configuration as an initialized ParameterMap.

Returns:

an initialized ParameterMap.

isInitialized

boolean isInitialized()

Get initialization status

Returns:

true, if initialized; false, else.