io.cdap.wrangler.service.directive

Class AbstractDirectiveHandler

java.lang.Object

io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable<T>

io.cdap.cdap.internal.api.AbstractPluginConfigurable<V>

io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

io.cdap.cdap.api.service.http.AbstractSystemHttpServiceHandler

io.cdap.wrangler.service.common.AbstractWranglerHandler

io.cdap.wrangler.service.directive.AbstractDirectiveHandler

All Implemented Interfaces:

io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>, io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Direct Known Subclasses:

DirectivesHandler, WorkspaceHandler

public class AbstractDirectiveHandler
extends AbstractWranglerHandler

Abstract handler which contains common logic for v1 and v2 endpoints TODO: CDAP-18015 Refactor and add unit test for methods in this class

Nested Class Summary

Nested classes/interfaces inherited from class io.cdap.wrangler.service.common.AbstractWranglerHandler

AbstractWranglerHandler.NamespacedResponder<T>, AbstractWranglerHandler.NamespacedResponderRunnable

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COLUMN_NAME
protected DirectiveRegistry	composite
protected static String	DELIMITER_HEADER
protected static String	RECORD_DELIMITER_HEADER

Constructor Summary

Constructors

Constructor and Description
AbstractDirectiveHandler()

Method Summary

Modifier and Type	Method and Description
static Row	createUberRecord(List<Row> rows) Creates a uber record after iterating through all rows.
void	destroy() Closes the resources help by the composite registry.
protected <E extends Exception> List<Row>	executeDirectives(String namespace, List<String> directives, List<Row> sample, GrammarWalker.Visitor<E> grammarVisitor)
protected DirectiveExecutionResponse	generateExecutionResponse(List<Row> rows, int limit) Transform the rows to response that is user friendly.
protected WorkspaceValidationResult	getWorkspaceSummary(List<Row> rows) Get the summary for the workspace rows
void	initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context)

Methods inherited from class io.cdap.wrangler.service.common.AbstractWranglerHandler

getConnection, getValidatedConnection, getValidatedConnection, getWorkspace, respond, respond, respond, shouldCopyHeader

Methods inherited from class io.cdap.cdap.api.service.http.AbstractSystemHttpServiceHandler

createTable

Methods inherited from class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler

configure, configure, getConfigurer, getContext, setProperties

Methods inherited from class io.cdap.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Field Detail

COLUMN_NAME

protected static final String COLUMN_NAME

See Also:

Constant Field Values

RECORD_DELIMITER_HEADER

protected static final String RECORD_DELIMITER_HEADER

See Also:

Constant Field Values

DELIMITER_HEADER

protected static final String DELIMITER_HEADER

See Also:

Constant Field Values

composite

protected DirectiveRegistry composite

Constructor Detail

AbstractDirectiveHandler

public AbstractDirectiveHandler()

Method Detail

initialize

public void initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context)
                throws Exception

Specified by:

initialize in interface io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>

Specified by:

initialize in interface io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Overrides:

initialize in class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Throws:

Exception

destroy

public void destroy()

Closes the resources help by the composite registry.

Specified by:

destroy in interface io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>

Specified by:

destroy in interface io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Overrides:

destroy in class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

executeDirectives

protected <E extends Exception> List<Row> executeDirectives(String namespace,
                                                            List<String> directives,
                                                            List<Row> sample,
                                                            GrammarWalker.Visitor<E> grammarVisitor)
                                                     throws DirectiveParseException,
                                                            E extends Exception

Throws:

DirectiveParseException

E extends Exception

generateExecutionResponse

protected DirectiveExecutionResponse generateExecutionResponse(List<Row> rows,
                                                               int limit)
                                                        throws Exception

Transform the rows to response that is user friendly. Also generates the summary from the rows.

Throws:

Exception

getWorkspaceSummary

protected WorkspaceValidationResult getWorkspaceSummary(List<Row> rows)
                                                 throws Exception

Get the summary for the workspace rows

Throws:

Exception

createUberRecord

public static Row createUberRecord(List<Row> rows)

Creates a uber record after iterating through all rows.

Parameters:

rows - list of all rows.

Returns:

A single record will rows merged across all columns.