CLI

java.lang.Object
- cli.CLI

All Implemented Interfaces:

java.lang.Runnable
```
public class CLI
extends java.lang.Object
implements java.lang.Runnable
```
This class provides an interactive command line interface for the user. It uses the CLIParser class for parsing the user input.

Field Summary

Fields
Modifier and Type Field and Description

protected ExtractionController controller

Fields
Modifier and Type	Field and Description
`protected ExtractionController`	`controller`

Constructor Summary

Constructors
Constructor and Description

CLI(ExtractionController controller)
Constructor called by the ExtractionController to start the command line interface at application start.

Constructors
Constructor and Description
`CLI(ExtractionController controller)` Constructor called by the `ExtractionController` to start the command line interface at application start.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addFile(java.lang.String filePath)` Add a file to the default profile
`protected void`	`addFileToProfile(java.lang.String file, java.lang.String profileUUID)` Adds a file as `Part` to a `Profile`, when the user types "add2Profile [FILE] [PROFILE_UUID]".
`protected void`	`addModuleToProfile(java.lang.String moduleName, java.lang.String profileUUID)` Adds an to a `Profile`, when the user types "addModule [MODULE] [PROFILE_UUID]" whereas [MODULE] is the name of the `GenericModule` that serves as template for the `AbstractModule`.
`void`	`createProfileFromTemplate(java.lang.String[] args)` Creates a `Profile` from a `ProfileTemplate`, when the user types "template2profile [TEMPLATE_NAME]"
`protected void`	`enableModule(java.lang.String moduleName, java.lang.String profileUUID, boolean enable)` TODO: problem if there are more then one modules with the same name, because of the identification via module name.
`protected void`	`enableProfile(java.lang.String profileUUID, boolean enable)` Enables or disables a `Profile`, when the user types "enable [PROFILE_UUID]".
`protected void`	`removeFileFromProfile(java.lang.String file, java.lang.String profileUUID)` Removes a `Part` from a `Profile`, when the user types "removeFile [FILE] [PROFILE_UUID]"
`void`	`removeModuleFromProfile(java.lang.String moduleName, java.lang.String profileUUID)` TODO: problem if there are more then one modules with the same name, because of the identification via module name.
`void`	`run()` run method of the cli thread that prints continuously the prompt and executes entered user commands.
`protected void`	`selectAll(java.lang.String profileUUID, boolean enable)` Method called to enable or disable all `AbstractModule`s belonging to a `Profile`.
`protected void`	`showDescription(java.lang.String moduleName)` Shows the description of a `GenericModule`, if the user types "module [MODULE]"
`void`	`showModuleConfiguration(java.lang.String moduleName, java.lang.String profileUUID)` TODO: problem if there are more then one modules with the same name, because of the identification via module name.
`protected void`	`showModules()` Show a list of all available `GenericModule`s via CLI, if the "modules" command is executed.
`protected void`	`showProfile(java.lang.String profileUUID)` Lists all `Part`s and `AbstractModule`s of a `Profile`, when the user types "profile [PROFILE_UUID]"
`protected void`	`showProfiles()` Shows a list of all current `Profile`s, when the user types "profiles".
`void`	`showTemplates()` Lists all available `ProfileTemplate`s, when the user types "templates"
`protected void`	`status()` Method executed, if the "status" command was entered: View if continuous extraction and daemon observation is active.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - controller
```
protected final ExtractionController controller
```
- Constructor Detail
  - CLI
```
public CLI(ExtractionController controller)
```
    Constructor called by the ExtractionController to start the command line interface at application start.
    
    Parameters:
    
    controller - reference to the applications ExtractionController
- Method Detail
  - run
```
public void run()
```
    run method of the cli thread that prints continuously the prompt and executes entered user commands.
    
    Specified by:
    
    run in interface java.lang.Runnable
  - status
```
protected void status()
```
    Method executed, if the "status" command was entered: View if continuous extraction and daemon observation is active.
  - selectAll
```
protected void selectAll(java.lang.String profileUUID,
                         boolean enable)
```
    Method called to enable or disable all AbstractModules belonging to a Profile.
    
    Parameters:
    
    profileUUID - UUID of the Profile
    
    enable - flag if the modules should be enabled or disabled
  - addFile
```
protected void addFile(java.lang.String filePath)
```
    Add a file to the default profile
    
    Parameters:
    
    filePath - path to the file that should be added
  - showModules
```
protected void showModules()
```
    Show a list of all available GenericModules via CLI, if the "modules" command is executed.
  - showProfiles
```
protected void showProfiles()
```
    Shows a list of all current Profiles, when the user types "profiles".
  - showProfile
```
protected void showProfile(java.lang.String profileUUID)
```
    Lists all Parts and AbstractModules of a Profile, when the user types "profile [PROFILE_UUID]"
    
    Parameters:
    
    UUID -
  - removeFileFromProfile
```
protected void removeFileFromProfile(java.lang.String file,
                                     java.lang.String profileUUID)
```
    Removes a Part from a Profile, when the user types "removeFile [FILE] [PROFILE_UUID]"
    
    Parameters:
    
    file - String path to the file that is represented by the Part to be removed
    
    profileUUID - UUID of the Profile were the Part belongs to
  - addFileToProfile
```
protected void addFileToProfile(java.lang.String file,
                                java.lang.String profileUUID)
```
    Adds a file as Part to a Profile, when the user types "add2Profile [FILE] [PROFILE_UUID]".
    
    Parameters:
    
    file -
    
    profileUUID - UUID of the Profile were the Part belongs to
  - enableModule
```
protected void enableModule(java.lang.String moduleName,
                            java.lang.String profileUUID,
                            boolean enable)
```
    TODO: problem if there are more then one modules with the same name, because of the identification via module name. Enables or disables the extraction of an AbstractModule, when the user types "select [MODULE] [PROFILE_UUID]" or "unselect [MODULE] [PROFILE_UUID]"
    
    Parameters:
    
    moduleName - name of the module
    
    profileUUID - UUID of the Profile where the module belongs to
    
    enable - flags whether the module should be enabled or disabled.
  - showDescription
```
protected void showDescription(java.lang.String moduleName)
```
    Shows the description of a GenericModule, if the user types "module [MODULE]"
    
    Parameters:
    
    moduleName -
  - addModuleToProfile
```
protected void addModuleToProfile(java.lang.String moduleName,
                                  java.lang.String profileUUID)
```
    Adds an to a Profile, when the user types "addModule [MODULE] [PROFILE_UUID]" whereas [MODULE] is the name of the GenericModule that serves as template for the AbstractModule.
    
    Parameters:
    
    moduleName - name of the template GenericModule
    
    profileUUID - UUID of the Profile where the module should be added.
  - removeModuleFromProfile
```
public void removeModuleFromProfile(java.lang.String moduleName,
                                    java.lang.String profileUUID)
```
    TODO: problem if there are more then one modules with the same name, because of the identification via module name. Removes an AbstractModule form a Profile when the user types "removeModule [MODULE] [PROFILE_UUID]"
    
    Parameters:
    
    moduleName -
    
    profileUUID -
  - showModuleConfiguration
```
public void showModuleConfiguration(java.lang.String moduleName,
                                    java.lang.String profileUUID)
```
    TODO: problem if there are more then one modules with the same name, because of the identification via module name. Shows the configuration of an AbstractModule when the user types "show [MODULE] [PROFILE_UUID]"
    
    Parameters:
    
    moduleName - name of the module
    
    profileUUID - UUID of the Profile where the module belongs to
  - enableProfile
```
protected void enableProfile(java.lang.String profileUUID,
                             boolean enable)
```
    Enables or disables a Profile, when the user types "enable [PROFILE_UUID]".
    
    Parameters:
    
    profileUUID - UUID of the profile, given by the user
    
    enable - flag if the profile should be enabled, or disabled.
  - showTemplates
```
public void showTemplates()
```
    Lists all available ProfileTemplates, when the user types "templates"
  - createProfileFromTemplate
```
public void createProfileFromTemplate(java.lang.String[] args)
```
    Creates a Profile from a ProfileTemplate, when the user types "template2profile [TEMPLATE_NAME]"
    
    Parameters:
    
    args - user enter separated by spaces

Class CLI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

controller

Constructor Detail

CLI

Method Detail

run

status

selectAll

addFile

showModules

showProfiles

showProfile

removeFileFromProfile

addFileToProfile

enableModule

showDescription

addModuleToProfile

removeModuleFromProfile

showModuleConfiguration

enableProfile

showTemplates

createProfileFromTemplate