Package org.terrier.applications

Class CLITool.CLIParsedCLITool

java.lang.Object

org.terrier.applications.CLITool

org.terrier.applications.CLITool.CLIParsedCLITool

Direct Known Subclasses:

AbstractQuerying.AbstractQueryingCommand, BatchEvaluationCommand, BatchIndexing.Command, CLITool.HelpAliasCLITool, CLITool.HelpCLITool, IndexStatsCommand, IndexUtil.Command, Inverted2DirectCommand, ShowDocumentCommand, SimpleJettyHTTPServer.Command, SingleIndexRestServer

Enclosing class:

CLITool

public abstract static class CLITool.CLIParsedCLITool
extends CLITool

Nested Class Summary

Nested classes/interfaces inherited from class org.terrier.applications.CLITool

CLITool.CLIParsedCLITool, CLITool.HelpAliasCLITool, CLITool.HelpCLITool

Field Summary

Fields inherited from class org.terrier.applications.CLITool

PLATFORM_MODULE, POPULAR_COMMANDS

Constructor Summary

Constructors

Constructor	Description
CLIParsedCLITool()

Method Summary

Modifier and Type	Method	Description
protected IndexRef	getIndexRef(org.apache.commons.cli.CommandLine line)
protected org.apache.commons.cli.Options	getOptions()
java.lang.String	help()	Return a long message about how to use this command
int	run(java.lang.String[] args)
abstract int	run(org.apache.commons.cli.CommandLine line)

Methods inherited from class org.terrier.applications.CLITool

commandaliases, commandname, helpsummary, main, run, run, setConfiguration, sourcepackage

Methods inherited from class java.lang.Object

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

Constructor Detail

CLIParsedCLITool

public CLIParsedCLITool()

Method Detail

getOptions

protected org.apache.commons.cli.Options getOptions()

getIndexRef

protected IndexRef getIndexRef(org.apache.commons.cli.CommandLine line)

help

public java.lang.String help()

Description copied from class: CLITool

Return a long message about how to use this command

Overrides:

help in class CLITool

run

public final int run(java.lang.String[] args)
              throws java.lang.Exception

Specified by:

run in class CLITool

Throws:

java.lang.Exception

run

public abstract int run(org.apache.commons.cli.CommandLine line)
                 throws java.lang.Exception

Throws:

java.lang.Exception