org.apache.lens.cli.commands.annotations

Class LensSegmentationCommands

java.lang.Object

org.apache.lens.cli.commands.BaseLensCommand

org.apache.lens.cli.commands.LensCRUDCommand<T>

org.apache.lens.cli.commands.BaseTableCrudCommand<XSegmentation>

org.apache.lens.cli.commands.annotations.LensSegmentationCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker, org.springframework.shell.core.ExecutionProcessor

@Component
 @UserDocumentation(title="Commands for Segmentation Management",
                   description="These command provide CRUD for Segmentation")
public class LensSegmentationCommands
extends BaseTableCrudCommand<XSegmentation>

Field Summary

Fields inherited from class org.apache.lens.cli.commands.BaseLensCommand

DATE_FMT, DATE_PARSER

Constructor Summary

Constructors

Constructor and Description
LensSegmentationCommands()

Method Summary

Modifier and Type	Method and Description
String	createSegmentation(File path) Creates the segmentation
String	describeSegmentation(String name) Describe segmentation.
APIResult	doUpdate(String name, String path)
String	dropSegmentation(String name) Drop segmentation.
List<String>	getAll()
String	showSegmentations(String cubeName) Show segmentation
String	updateSegmentation(String name, File path) Update segmentation.

Methods inherited from class org.apache.lens.cli.commands.BaseTableCrudCommand

showAll

Methods inherited from class org.apache.lens.cli.commands.LensCRUDCommand

create, describe, drop, getSingleObjectName, showAll, update

Methods inherited from class org.apache.lens.cli.commands.BaseLensCommand

afterReturningInvocation, afterThrowingInvocation, beforeInvocation, formatDate, formatJson, getClient, getClientWrapper, getOrDefaultQueryHandleString, getValidPath, removePrefixBeforeURI, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

LensSegmentationCommands

public LensSegmentationCommands()

Method Detail

showSegmentations

@CliCommand(value="show segmentations",
            help="display list of segmentations in current database. If optional <cube_name> is supplied, only segmentations belonging to cube <cube_name> will be displayed")
public String showSegmentations(@CliOption(key={"","cube_name"},mandatory=false,help="<cube_name>")
                                                                                                                                                                                                                                                       String cubeName)

Show segmentation

Returns:

the string

createSegmentation

@CliCommand(value="create segmentation",
            help="create a new segmentation, taking spec from <path-to-segmentation-spec file>")
public String createSegmentation(@CliOption(key={"","path"},mandatory=true,help="<path-to-segmentation-spec file>") @NonNull
                                                                                                                                                                           File path)

Creates the segmentation

Parameters:

path - the segmentation spec

Returns:

the string

describeSegmentation

@CliCommand(value="describe segmentation",
            help="describe segmentation <segmentation_name>")
public String describeSegmentation(@CliOption(key={"","name"},mandatory=true,help="<segmentation_name>")
                                                                                                                                            String name)

Describe segmentation.

Parameters:

name - the segmentation name

Returns:

the string

updateSegmentation

@CliCommand(value="update segmentation",
            help="update segmentation <segmentation_name>, taking spec from <path-to-segmentation-spec file>")
public String updateSegmentation(@CliOption(key={"","name"},mandatory=true,help="<segmentation_name>")
                                                                                                                                                                                         String name,
                                                                                                                                                                                         @CliOption(key={"","path"},mandatory=true,help="<path-to-segmentation-spec-file>") @NonNull
                                                                                                                                                                                         File path)

Update segmentation.

Parameters:

name - the segmentation to be updated

path - path to spec file

Returns:

the string

dropSegmentation

@CliCommand(value="drop segmentation",
            help="drop segmentation <segmentation_name>")
public String dropSegmentation(@CliOption(key={"","name"},mandatory=true,help="<segmentation_name>")
                                                                                                                                String name)

Drop segmentation.

Parameters:

name - the segmentation to be dropped

Returns:

the string

getAll

public List<String> getAll()

Specified by:

getAll in class LensCRUDCommand<XSegmentation>

doUpdate

public APIResult doUpdate(String name,
                          String path)

Specified by:

doUpdate in class LensCRUDCommand<XSegmentation>