org.utgenome.shell
Class UTGBShellCommand

java.lang.Object
  extended by org.utgenome.shell.UTGBShellCommand
All Implemented Interfaces:
java.lang.Comparable<UTGBShellCommand>
Direct Known Subclasses:
AddAction, Clean, Compile, Create, Deploy, Eclipse, FastqRename, FastqToFasta, FastqToSAM, GWT, GWTCompile, Illumina2Fastq, Import, Keyword, Maven, Pack, QSeqToFastq, Repair, Sam2Wig, Sequence, Server, SVNAdd, Upgrade

public abstract class UTGBShellCommand
extends java.lang.Object
implements java.lang.Comparable<UTGBShellCommand>

A common implementation of the UTGBShell's sub commands

Author:
leo

Field Summary
static java.lang.String APP_FOLDER
           
static java.lang.String EXPLODED_WEBAPP_DIR
           
protected  UTGBShell.UTGBShellOption globalOption
           
static java.lang.String SRC_FOLDER
           
static java.lang.String WEBAPP_FOLDER
           
 
Constructor Summary
UTGBShellCommand()
           
 
Method Summary
 int compareTo(UTGBShellCommand o)
           
 void createContextXML(java.lang.String contextPath, java.lang.String projectRoot, boolean reloadable)
           
 void createFileFromTemplate(java.lang.Class<?> baseClass, java.lang.String templateFilePath, java.lang.String relativePathOfTarget, java.util.Properties prop)
           
static void createFileFromTemplate(java.lang.Class<?> baseClass, java.lang.String templateFilePath, java.lang.String projectFolder, java.lang.String relativePathOfTarget, java.util.Properties prop, boolean overWrite)
           
abstract  void execute(java.lang.String[] args)
           
 void execute(UTGBShell.UTGBShellOption globalOption, java.lang.String[] args)
           
 java.io.File getConfigFile()
           
 java.io.File getObsolteConfigurationFile()
           
abstract  java.lang.String getOneLinerDescription()
           
 java.lang.Object getOptionHolder()
           
static java.lang.String getPath(java.io.File f)
           
 java.io.File getProjectResourcePath(java.lang.String relativePathFromTheProjectRoot)
           
 java.io.File getProjectRoot()
           
 boolean isInProjectRoot()
           
 UTGBConfig loadUTGBConfig()
           
 void maven(java.lang.String commandLine)
           
abstract  java.lang.String name()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

APP_FOLDER

public static final java.lang.String APP_FOLDER
See Also:
Constant Field Values

SRC_FOLDER

public static final java.lang.String SRC_FOLDER
See Also:
Constant Field Values

WEBAPP_FOLDER

public static final java.lang.String WEBAPP_FOLDER
See Also:
Constant Field Values

EXPLODED_WEBAPP_DIR

public static final java.lang.String EXPLODED_WEBAPP_DIR
See Also:
Constant Field Values

globalOption

protected UTGBShell.UTGBShellOption globalOption
Constructor Detail

UTGBShellCommand

public UTGBShellCommand()
Method Detail

name

public abstract java.lang.String name()

execute

public void execute(UTGBShell.UTGBShellOption globalOption,
                    java.lang.String[] args)
             throws java.lang.Exception
Throws:
java.lang.Exception

execute

public abstract void execute(java.lang.String[] args)
                      throws java.lang.Exception
Throws:
java.lang.Exception

getOneLinerDescription

public abstract java.lang.String getOneLinerDescription()

getOptionHolder

public java.lang.Object getOptionHolder()

getProjectRoot

public java.io.File getProjectRoot()

isInProjectRoot

public boolean isInProjectRoot()

getProjectResourcePath

public java.io.File getProjectResourcePath(java.lang.String relativePathFromTheProjectRoot)

getConfigFile

public java.io.File getConfigFile()

getObsolteConfigurationFile

public java.io.File getObsolteConfigurationFile()

maven

public void maven(java.lang.String commandLine)
           throws UTGBShellException
Throws:
UTGBShellException

loadUTGBConfig

public UTGBConfig loadUTGBConfig()
                          throws UTGBShellException
Throws:
UTGBShellException

compareTo

public int compareTo(UTGBShellCommand o)
Specified by:
compareTo in interface java.lang.Comparable<UTGBShellCommand>

getPath

public static java.lang.String getPath(java.io.File f)

createContextXML

public void createContextXML(java.lang.String contextPath,
                             java.lang.String projectRoot,
                             boolean reloadable)
                      throws UTGBShellException
Throws:
UTGBShellException

createFileFromTemplate

public void createFileFromTemplate(java.lang.Class<?> baseClass,
                                   java.lang.String templateFilePath,
                                   java.lang.String relativePathOfTarget,
                                   java.util.Properties prop)
                            throws UTGBShellException
Throws:
UTGBShellException

createFileFromTemplate

public static void createFileFromTemplate(java.lang.Class<?> baseClass,
                                          java.lang.String templateFilePath,
                                          java.lang.String projectFolder,
                                          java.lang.String relativePathOfTarget,
                                          java.util.Properties prop,
                                          boolean overWrite)
                                   throws UTGBShellException
Throws:
UTGBShellException


Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.1 Japan License.