org.obolibrary.robot

Class TemplateCommand

java.lang.Object

org.obolibrary.robot.TemplateCommand

All Implemented Interfaces:

Command

public class TemplateCommand
extends Object
implements Command

Handles inputs and outputs for the TemplateOperation.

Author:

James A. Overton

Field Summary

Fields inherited from interface org.obolibrary.robot.Command

global, missingFileError

Constructor Summary

Constructors

Constructor and Description
TemplateCommand() Initialize the command.

Method Summary

Modifier and Type	Method and Description
CommandState	execute(CommandState state, String[] args) Given an input state and command line arguments, build a new ontology from the given template, and return a state with the new ontology.
String	getDescription() Brief description of the command.
String	getName() Name of the command.
org.apache.commons.cli.Options	getOptions() Command-line options for the command.
String	getUsage() Command-line usage for the command.
void	main(String[] args) Handle the command-line and file operations for the TemplateOperation.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateCommand

public TemplateCommand()

Initialize the command.

Method Detail

getName

public String getName()

Name of the command.

Specified by:

getName in interface Command

Returns:

name

getDescription

public String getDescription()

Brief description of the command.

Specified by:

getDescription in interface Command

Returns:

description

getUsage

public String getUsage()

Command-line usage for the command.

Specified by:

getUsage in interface Command

Returns:

usage

getOptions

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

Command-line options for the command.

Specified by:

getOptions in interface Command

Returns:

options

main

public void main(String[] args)

Handle the command-line and file operations for the TemplateOperation.

Specified by:

main in interface Command

Parameters:

args - strings to use as arguments

execute

public CommandState execute(CommandState state,
                            String[] args)
                     throws Exception

Given an input state and command line arguments, build a new ontology from the given template, and return a state with the new ontology.

Specified by:

execute in interface Command

Parameters:

state - the state from the previous command, or null

args - the command-line arguments

Returns:

the state with the filtered ontology

Throws:

Exception - on any problem