org.corpus_tools.pepper.cli.PepperStarter Class Reference

The main class to start Pepper from the Console. More...

Classes
enum	COMMAND

Public Member Functions
	PepperStarter ()
	Initializes an instance of PepperStarter without a PepperConnector. More...
	PepperStarter (PepperConnector pepperConnector)
	Initializes an instance of PepperStarter. More...
PepperConnector	getPepper ()
void	setPepper (PepperConnector pepper)
	Sets a reference to Pepper via a PepperConnector.
PepperStarterConfiguration	getPepperConfiguration ()
void	setPepperConfiguration (PepperStarterConfiguration pepperConf)
String	help ()
	Help to all commands for Pepper. More...
String	list ()
	Returns a String containing a table with information about all available Pepper modules. More...
String	list (String moduleSelector)
	Returns a String containing a table with information about the passed Pepper module. More...
String	start_osgi ()
	Starts the OSGi environment.
String	stop_osgi ()
	Stops the OSGi environment.
String	clean ()
	Cleans the current Pepper instance and especially removes the OSGi workspace, to set up a new one. More...
String	debug ()
	Switches on/off the debug mode. More...
String	osgi ()
	Opens the OSGi console via an OSGiConsole object and delegates to it.
void	convert (String workFlowPath)
	Loads the passed workflow description file and starts the conversion. More...
String	installAndStart (List< String > params)
	Installs and starts a new Pepper module(s).
String	remove (List< String > params)
	Removes an existing Pepper module(s).
String	selfTest ()
	Calls PepperModule#isReadyToStart() for all Pepper modules. More...
String	fitness ()
	Returns a fitness report as a String. More...
String	conf ()
void	runInteractive ()
	Starts the interactive console of Pepper.

Static Public Member Functions
static String	getVersion ()
	Resolves the current Pepper version from a file named version.properties in the pepper-lib jar file. More...
static void	main (String[] args) throws Exception

Static Public Attributes
static final String	PROMPT = "pepper"
static final String	FILE_ENDING_PEPPER = "pepper"
	This is the default ending of a Pepper workflow description file.
static final int	CONSOLE_WIDTH = 120
	The standard width of the output console of Pepper.
static final int	CONSOLE_WIDTH_120 = 120
	The width of the output console of Pepper.
static final int	CONSOLE_WIDTH_80 = 80
	The width of the output console of Pepper, when os is windows.

Detailed Description

The main class to start Pepper from the Console.

Author

Florian

Constructor & Destructor Documentation

PepperStarter() [1/2]

org.corpus_tools.pepper.cli.PepperStarter.PepperStarter

(

)

Initializes an instance of PepperStarter without a PepperConnector.

Make sure to call method setPepper(PepperConnector) right after calling the constructor.

PepperStarter() [2/2]

org.corpus_tools.pepper.cli.PepperStarter.PepperStarter

(

PepperConnector

pepperConnector

)

Initializes an instance of PepperStarter.

Parameters

pepperConnector

a PepperConnector object via which the PepperStarter communicates with a Pepper instance

Member Function Documentation

clean()

String org.corpus_tools.pepper.cli.PepperStarter.clean

(

)

Cleans the current Pepper instance and especially removes the OSGi workspace, to set up a new one.

Returns

conf()

String org.corpus_tools.pepper.cli.PepperStarter.conf

(

)

Returns

a String containing all Pepper configurations formatted as table

convert()

void org.corpus_tools.pepper.cli.PepperStarter.convert

(

String

workFlowPath

)

Loads the passed workflow description file and starts the conversion.

Parameters

workFlowPath

debug()

String org.corpus_tools.pepper.cli.PepperStarter.debug

(

)

Switches on/off the debug mode.

Returns

fitness()

String org.corpus_tools.pepper.cli.PepperStarter.fitness

(

)

Returns a fitness report as a String.

This report contains a fitness value for each module and if a module is not fit, the report is expanded for a detailed report containing one value for each fitness feature.

Returns

fitness report

getPepper()

PepperConnector org.corpus_tools.pepper.cli.PepperStarter.getPepper

(

)

Returns

a reference to Pepper via a PepperConnector

getPepperConfiguration()

PepperStarterConfiguration org.corpus_tools.pepper.cli.PepperStarter.getPepperConfiguration

(

)

Returns

configuration for PepperStarter

getVersion()

static String org.corpus_tools.pepper.cli.PepperStarter.getVersion ( )

static

Resolves the current Pepper version from a file named version.properties in the pepper-lib jar file.

Returns

the current Pepper version

help()

String org.corpus_tools.pepper.cli.PepperStarter.help

(

)

Help to all commands for Pepper.

Returns

list() [1/2]

String org.corpus_tools.pepper.cli.PepperStarter.list

(

)

Returns a String containing a table with information about all available Pepper modules.

Returns

list() [2/2]

String org.corpus_tools.pepper.cli.PepperStarter.list

(

String

moduleSelector

)

Returns a String containing a table with information about the passed Pepper module.

Parameters

moduleSelector

either the name of a module or the number of a module

Returns

main()

static void org.corpus_tools.pepper.cli.PepperStarter.main ( String[]  args ) throws Exception

static

Parameters

args

selfTest()

String org.corpus_tools.pepper.cli.PepperStarter.selfTest

(

)

Calls PepperModule#isReadyToStart() for all Pepper modules.

Returns

setPepperConfiguration()

void org.corpus_tools.pepper.cli.PepperStarter.setPepperConfiguration

(

PepperStarterConfiguration

pepperConf

)

Parameters

pepperConf

configuration for PepperStarter