eu.ehri.project.commands

Class BaseCommand

java.lang.Object

eu.ehri.project.commands.BaseCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

Check, CmdEntryPoint, CountryAdd, DeleteEntities, EntityAdd, EntityDelete, GenSchema, GetEntity, GraphSON, ImportCommand, ImportCsvCommand, Initialize, ListEntities, LoadFixtures, RelationAdd, SkosVocabularyImport, UserAdd, UserListEntities, UserMod

public abstract class BaseCommand
extends Object
implements Command

Abstract base class for commands. Provides the main entry points for interaction:

• Set options
• Get help
• Get usage
• Execute with options

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.cli.Options	options

Constructor Summary

Constructors

Constructor and Description
BaseCommand()

Method Summary

Modifier and Type	Method and Description
protected Api	api(com.tinkerpop.frames.FramedGraph<?> graph, Accessor accessor)
int	exec(com.tinkerpop.frames.FramedGraph<?> graph, String[] args) Execute this command with the given database and un-parsed command line arguments
abstract int	execWithOptions(com.tinkerpop.frames.FramedGraph<?> graph, org.apache.commons.cli.CommandLine cmdLine) Execute this command with the given database and parsed command line arguments.
String	getDetailedHelp() Get the formatted help blurb, including options.
abstract String	getHelp() Get information about the functionality of the command.
abstract String	getUsage() Get a short hint about the usage of the command.
protected void	setCustomOptions(org.apache.commons.cli.Options options)

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.ehri.project.commands.Command

getHelpFooter

Field Detail

options

protected final org.apache.commons.cli.Options options

Constructor Detail

BaseCommand

public BaseCommand()

Method Detail

setCustomOptions

protected void setCustomOptions(org.apache.commons.cli.Options options)

getHelp

public abstract String getHelp()

Description copied from interface: Command

Get information about the functionality of the command.

Specified by:

getHelp in interface Command

Returns:

a help text

getUsage

public abstract String getUsage()

Description copied from interface: Command

Get a short hint about the usage of the command.

Specified by:

getUsage in interface Command

Returns:

a usage text

exec

public final int exec(com.tinkerpop.frames.FramedGraph<?> graph,
                      String[] args)
               throws Exception

Execute this command with the given database and un-parsed command line arguments

Specified by:

exec in interface Command

Parameters:

graph - the graph database

args - the raw command line arguments

Returns:

a command return code

Throws:

Exception

getDetailedHelp

public String getDetailedHelp()

Description copied from interface: Command

Get the formatted help blurb, including options.

Specified by:

getDetailedHelp in interface Command

Returns:

a help string.

execWithOptions

public abstract int execWithOptions(com.tinkerpop.frames.FramedGraph<?> graph,
                                    org.apache.commons.cli.CommandLine cmdLine)
                             throws Exception

Execute this command with the given database and parsed command line arguments.

Specified by:

execWithOptions in interface Command

Parameters:

graph - the graph database

cmdLine - the parsed command line object

Returns:

a command return code

Throws:

Exception

api

protected Api api(com.tinkerpop.frames.FramedGraph<?> graph,
                  Accessor accessor)