TRECQuerying.Command (Terrier Information Retrieval Platform 5.5 API)

java.lang.Object
- org.terrier.applications.CLITool
- - org.terrier.applications.CLITool.CLIParsedCLITool
  - - org.terrier.applications.AbstractQuerying.AbstractQueryingCommand
    - - org.terrier.applications.batchquerying.TRECQuerying.Command

Direct Known Subclasses:: ParallelTRECQuerying.Command

Enclosing class:: TRECQuerying

public static class TRECQuerying.Command
extends AbstractQuerying.AbstractQueryingCommand

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
Modifier Constructor Description

Command()

protected Command(java.lang.Class<? extends TRECQuerying> clz)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Set<java.lang.String>`	`commandaliases()`	What short commands aliases should this command respond to
`java.lang.String`	`commandname()`	What commandname should this command respond to
`protected org.apache.commons.cli.Options`	`getOptions()`
`java.lang.String`	`helpsummary()`	Returns a short sentence about what this command is for
`int`	`run(org.apache.commons.cli.CommandLine line, AbstractQuerying q)`

Methods inherited from class org.terrier.applications.AbstractQuerying.AbstractQueryingCommand
run, sourcepackage

Methods inherited from class org.terrier.applications.CLITool.CLIParsedCLITool
getIndexRef, help, run

Methods inherited from class org.terrier.applications.CLITool
main, run, run, setConfiguration

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Command
```
public Command()
```
  - Command
```
protected Command(java.lang.Class<? extends TRECQuerying> clz)
```
- Method Detail
  - getOptions
```
protected org.apache.commons.cli.Options getOptions()
```
    Overrides:
    
    getOptions in class AbstractQuerying.AbstractQueryingCommand
  - commandname
```
public java.lang.String commandname()
```
    Description copied from class: CLITool
    
    What commandname should this command respond to
    
    Overrides:
    
    commandname in class CLITool
  - commandaliases
```
public java.util.Set<java.lang.String> commandaliases()
```
    Description copied from class: CLITool
    
    What short commands aliases should this command respond to
    
    Overrides:
    
    commandaliases in class CLITool
  - helpsummary
```
public java.lang.String helpsummary()
```
    Description copied from class: CLITool
    
    Returns a short sentence about what this command is for
    
    Overrides:
    
    helpsummary in class CLITool
  - run
```
public int run(org.apache.commons.cli.CommandLine line,
               AbstractQuerying q)
        throws java.lang.Exception
```
    Specified by:
    
    run in class AbstractQuerying.AbstractQueryingCommand
    
    Throws:
    
    java.lang.Exception