org.lenskit.cli

Interface Command

All Known Implementing Classes:

Crossfold, GlobalRecommend, Graph, PackRatings, Predict, Recommend, RunScript, Simulate, TrainModel, TrainTest, ValidatePack, Version

public interface Command

Interface implemented by all CLI subcommands. Commands are detected by looking for implementations of this interface using the Java ServiceLoader framework. New implementations can be registered conveniently using the AutoService annotation.

Since:

2.1

Method Summary

Modifier and Type	Method and Description
void	configureArguments(net.sourceforge.argparse4j.inf.ArgumentParser parser) Configure the argument parser for this command.
void	execute(net.sourceforge.argparse4j.inf.Namespace options) Execute the command.
String	getHelp() Get the command’s help.
String	getName() Get the name of the command.

Method Detail

getName

String getName()

Get the name of the command.

Returns:

The command’s name.

getHelp

String getHelp()

Get the command’s help.

Returns:

The command’s help.

configureArguments

void configureArguments(net.sourceforge.argparse4j.inf.ArgumentParser parser)

Configure the argument parser for this command.

Parameters:

parser - The argument parser into which the arguments should be configured. This will already be a subparser, the command is not responsible for creating that.

execute

void execute(net.sourceforge.argparse4j.inf.Namespace options)
      throws Exception

Execute the command.

Parameters:

options - The command-line options.

Throws:

Exception - if an error occurs in the command.