eu.ehri.project.commands

Interface Command

All Known Implementing Classes:

BaseCommand, Check, CmdEntryPoint, CountryAdd, CsvConceptImport, CsvDocDescImport, DcImport, DeleteEntities, EacImport, EadAsVirtualCollectionImport, EadImport, EagImport, EntityAdd, EntityDelete, GenSchema, GetEntity, GraphSON, ImportCommand, ImportCsvCommand, Initialize, ListEntities, LoadFixtures, PersonalitiesImport, RelationAdd, SkosVocabularyImport, UserAdd, UserListEntities, UserMod, UshmmEadImport

public interface Command

Command-line tools to perform actions on the graph database need to specify a help text about the functionality of the tool and a string to explain their usage.

Method Summary

Modifier and Type	Method and Description
int	exec(com.tinkerpop.frames.FramedGraph<?> graph, String[] args) Execute this command with the given arguments.
int	execWithOptions(com.tinkerpop.frames.FramedGraph<?> graph, org.apache.commons.cli.CommandLine cmdLine) Execute this command with the given command line options.
String	getDetailedHelp() Get the formatted help blurb, including options.
String	getHelp() Get information about the functionality of the command.
default String	getHelpFooter() Get footer text for the help.
String	getUsage() Get a short hint about the usage of the command.

Method Detail

getHelp

String getHelp()

Get information about the functionality of the command.

Returns:

a help text

getUsage

String getUsage()

Get a short hint about the usage of the command.

Returns:

a usage text

getDetailedHelp

String getDetailedHelp()

Get the formatted help blurb, including options.

Returns:

a help string.

getHelpFooter

default String getHelpFooter()

Get footer text for the help.

Returns:

a text string

execWithOptions

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

Execute this command with the given command line options.

Parameters:

graph - the graph database

cmdLine - the command line options

Returns:

a status code (0 = success)

Throws:

Exception

exec

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

Execute this command with the given arguments.

Parameters:

graph - the graph database

args - the raw argument strings

Returns:

a status code (0 = success)

Throws:

Exception