io.cdap.wrangler.registry

Interface DirectiveRegistry

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CompositeDirectiveRegistry, SystemDirectiveRegistry, UserDirectiveRegistry

public interface DirectiveRegistry
extends Closeable

A directive registry maintains a collection of directives either system provided or user provided.

The directive information is stored within the registry. The information includes name,class,usage and usage definition.

See Also:

DirectiveInfo

Method Summary

Modifier and Type	Method and Description
DirectiveInfo	get(String namespace, String name) Given the name of the directive, returns the information related to the directive.
Iterable<DirectiveInfo>	list(String namespace) List the directives in the specified namespace
void	reload(String namespace) This method reloads the directives from the artifacts into the registry.

Methods inherited from interface java.io.Closeable

close

Method Detail

list

Iterable<DirectiveInfo> list(String namespace)

List the directives in the specified namespace

Parameters:

namespace - the namespace to list from

Returns:

directives in the specified namespace

get

@Nullable
DirectiveInfo get(String namespace,
                            String name)
                     throws DirectiveLoadException

Given the name of the directive, returns the information related to the directive.

Parameters:

namespace - the namespace of the directive

name - of the directive to be retrieved from the registry.

Returns:

an instance of DirectiveInfo if found, else null.

Throws:

DirectiveLoadException

reload

void reload(String namespace)
     throws DirectiveLoadException

This method reloads the directives from the artifacts into the registry. Any implementation of this method should provide support for deletes, updates and additions.

Parameters:

namespace - the namespace to reload directives in

Throws:

DirectiveLoadException - thrown when there are any issues with loading directives into the registry.