uk.ac.ebi.microarray.zooma.utils
Interface ZoomaMode.Operation

Enclosing interface:

ZoomaMode

public static interface ZoomaMode.Operation

Defines an operation on a operation. Each operation has a series of descriptive getter methods for invoking on the command line.

Author:

Tony Burdett

Method Summary

java.lang.String	getOperationDescription() A brief description of what this operation does.
java.lang.String	getOperationName() The name of this operation.
java.lang.String	getOperationShortName() The short name for this operation.

Method Detail

getOperationShortName

java.lang.String getOperationShortName()

The short name for this operation. This will usually be the first one or two characters of the operation full name. This value binds to the user supplied parameter when zooma is invoked from the command line.

Returns:

the short name of the operation

getOperationName

java.lang.String getOperationName()

The name of this operation. Each mode can have several operations, and this parameter is used to distinguish between them. When a zooma mode is invoked, the operation must be specified.

Returns:

the name of this operation

getOperationDescription

java.lang.String getOperationDescription()

A brief description of what this operation does. This is used to supply help to users.

Returns:

the operation description