ubic.gemma.core.util

Interface CLI

All Known Implementing Classes:

AbstractCLI, AbstractCLIContextCLI, AbstractSpringAwareCLI, AffyDataFromCelCli, AffyProbeCollapseCli, ArrayDesignAlternativePopulateCli, ArrayDesignAnnotationFileCli, ArrayDesignAuditTrailCleanupCli, ArrayDesignBioSequenceDetachCli, ArrayDesignBlatCli, ArrayDesignMapSummaryCli, ArrayDesignMergeCli, ArrayDesignProbeCleanupCLI, ArrayDesignProbeMapperCli, ArrayDesignProbeRenamerCli, ArrayDesignRepeatScanCli, ArrayDesignSequenceAssociationCli, ArrayDesignSequenceManipulatingCli, ArrayDesignSubsumptionTesterCli, BatchEffectPopulationCli, BibRefUpdaterCli, BioSequenceCleanupCli, BlacklistCli, CountObsoleteTermsCli, CtdDatabaseImporterCli, DatabaseViewGeneratorCLI, DeleteDiffExCli, DeleteEvidenceCLI, DeleteExperimentsCli, DgaDatabaseImporterCli, DifferentialExpressionAnalysisCli, EvidenceImporterAbstractCLI, EvidenceImporterCLI, ExperimentalDesignImportCli, ExperimentalDesignViewCli, ExperimentalDesignWriterCLI, ExpressionDataCorrMatCli, ExpressionDataMatrixWriterCLI, ExpressionExperimentDataFileGeneratorCli, ExpressionExperimentManipulatingCLI, ExpressionExperimentPlatformSwitchCli, ExpressionExperimentPrimaryPubCli, ExternalDatabaseAdderCli, ExternalDatabaseEvidenceImporterAbstractCLI, ExternalDatabaseUpdaterCli, ExternalFileGeneLoaderCLI, GeeqCli, GenericGenelistDesignGenerator, GeoGrabberCli, GwasDatabaseImporterCli, IndexGemmaCLI, LinkAnalysisCli, LoadEvidenceForClassifier, LoadExpressionDataCli, LoadSimpleExpressionDataCli, MakeExperimentPrivateCli, MakeExperimentsPublicCli, MeshTermFetcherCli, MultifunctionalityCli, NCBIGene2GOAssociationLoaderCLI, NcbiGeneLoaderCLI, OmimDatabaseImporterCli, OrderVectorsByDesignCli, ProcessedDataComputeCLI, PubMedLoaderCli, PubMedSearcher, ReplaceDataCli, RgdDatabaseImporterCli, RNASeqBatchInfoCli, RNASeqDataAddCli, SfariDatabaseImporterCli, SplitExperimentCli, SVDCli, TaxonLoaderCli, UpdatePubMedCli, VectorMergingCli

public interface CLI

Interface for CLI tools. Implementing this interface will make the tool detectable by GemmaCLI.

Author:

poirigui

Method Summary

Modifier and Type	Method and Description
int	executeCommand(String[] args) Execute the given command given CLI arguments.
GemmaCLI.CommandGroup	getCommandGroup() Obtain the command grup.
String	getCommandName() A short memorable name for the command that can be used to locate this class.
String	getShortDesc() Obtain a short description for this command explaining what it does.

Method Detail

getCommandName

String getCommandName()

A short memorable name for the command that can be used to locate this class.

Returns:

name; if null, this will not be available as a shortcut command.

getShortDesc

String getShortDesc()

Obtain a short description for this command explaining what it does.

getCommandGroup

GemmaCLI.CommandGroup getCommandGroup()

Obtain the command grup.

Returns:

the command group for this CLI

executeCommand

int executeCommand(String[] args)

Execute the given command given CLI arguments.