org.apache.lens.cli.commands

Class LensDimensionCommands

java.lang.Object

org.apache.lens.cli.commands.BaseLensCommand

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

org.apache.lens.cli.commands.ConceptualTableCrudCommand<XDimension>

org.apache.lens.cli.commands.LensDimensionCommands

All Implemented Interfaces:

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

@Component
 @UserDocumentation(title="Commands for Dimension Management",
                   description="These commands provide CRUD for Dimensions")
public class LensDimensionCommands
extends ConceptualTableCrudCommand<XDimension>

The Class LensDimensionCommands.

Field Summary

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

DATE_FMT, DATE_PARSER

Constructor Summary

Constructors

Constructor and Description
LensDimensionCommands()

Method Summary

Modifier and Type	Method and Description
String	createDimension(File path) Creates the dimension.
String	describeDimension(String name) Describe dimension.
APIResult	doUpdate(String name, String path)
String	dropDimension(String name) Drop dimension.
List<String>	getAll()
String	showDimensions() Show dimensions.
String	showJoinChains(String table)
String	showQueryableFields(String table, boolean flattened)
String	updateDimension(String name, File path) Update dimension.

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

getAllFields, getAllJoinChains

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

LensDimensionCommands

public LensDimensionCommands()

Method Detail

showDimensions

@CliCommand(value="show dimensions",
            help="show list of all dimensions in current database")
public String showDimensions()

Show dimensions.

Returns:

the string

createDimension

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

Creates the dimension.

Parameters:

path - the dimension spec

Returns:

the string

describeDimension

@CliCommand(value="describe dimension",
            help="describe dimension <dimension_name>")
public String describeDimension(@CliOption(key={"","name"},mandatory=true,help="<dimension_name>")
                                                                                                                                String name)

Describe dimension.

Parameters:

name - the dimension name

Returns:

the string

updateDimension

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

Update dimension.

Parameters:

name - the dimension to be updated

path - path to spec fild

Returns:

the string

dropDimension

@CliCommand(value="drop dimension",
            help="drop dimension <dimension_name>")
public String dropDimension(@CliOption(key={"","name"},mandatory=true,help="<dimension_name>")
                                                                                                                    String name)

Drop dimension.

Parameters:

name - the dimension

Returns:

the string

showQueryableFields

@CliCommand(value="dimension show fields",
            help="Show queryable fields of the given dimension <dimension_name>. Optionally specify <flattened> to include chained fields")
public String showQueryableFields(@CliOption(key={"","name"},mandatory=true,help="<dimension_name>")
                                                                                                                                                                                                                         String table,
                                                                                                                                                                                                                         @CliOption(key="flattened",mandatory=false,unspecifiedDefaultValue="false",specifiedDefaultValue="true",help="<flattened>")
                                                                                                                                                                                                                         boolean flattened)

showJoinChains

@CliCommand(value="dimension show joinchains",
            help="Show joinchains of the given dimension <dimension_name>. ")
public String showJoinChains(@CliOption(key={"","name"},mandatory=true,help="<dimension_name>")
                                                                                                                                                          String table)

getAll

public List<String> getAll()

Specified by:

getAll in class LensCRUDCommand<XDimension>

doUpdate

public APIResult doUpdate(String name,
                          String path)

Specified by:

doUpdate in class LensCRUDCommand<XDimension>