TrecEvalEvaluation.Command (Terrier Information Retrieval Platform 5.5 API)

java.lang.Object
- org.terrier.applications.CLITool
- - org.terrier.evaluation.TrecEvalEvaluation.Command

Enclosing class:: TrecEvalEvaluation

public static class TrecEvalEvaluation.Command
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

Command()

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
`java.lang.String`	`help()`	Return a long message about how to use this command
`java.lang.String`	`helpsummary()`	Returns a short sentence about what this command is for
`int`	`run(java.lang.String[] args)`
`java.lang.String`	`sourcepackage()`

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()
```
- Method Detail
  - 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
  - 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
  - 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(java.lang.String[] args)
        throws java.lang.Exception
```
    Specified by:
    
    run in class CLITool
    
    Throws:
    
    java.lang.Exception
  - sourcepackage
```
public java.lang.String sourcepackage()
```
    Overrides:
    
    sourcepackage in class CLITool