edu.ucla.sspace.mains

Class ESAMain

java.lang.Object

edu.ucla.sspace.mains.GenericMain

edu.ucla.sspace.mains.ESAMain

public class ESAMain
extends GenericMain

An executable class for running ExplicitSemanticAnalysis (ESA) from the command line. This class takes in several command line arguments.

• --overwrite=<boolean> specifies whether to overwrite the existing output files. The default is true. If set to false, a unique integer is inserted into the file name.
• --verbose | -v specifies whether to print runtime information to standard out

Author:

David Jurgens

See Also:

ExplicitSemanticAnalysis

Field Summary

Fields inherited from class edu.ucla.sspace.mains.GenericMain

argOptions, EXT, isMultiThreaded, verbose

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExtraOptions(ArgOptions options) Adds options to the provided ArgOptions instance, which will be used to parse the command line.
SemanticSpace	getSpace() Returns the SemanticSpace that will be used for processing.
protected SemanticSpaceIO.SSpaceFormat	getSpaceFormat() Returns the format in which the finished SemanticSpace should be saved.
static void	main(String[] args)
Properties	setupProperties() Returns the Properties object that will be used when calling SemanticSpace.processSpace(Properties).

Methods inherited from class edu.ucla.sspace.mains.GenericMain

addCorpusReaderIterators, addDocIterators, addFileIterators, getAlgorithmSpecifics, getDocumentIterator, handleExtraOptions, loadValidTermSet, parseDocumentsMultiThreaded, parseDocumentsSingleThreaded, postProcessing, processDocumentsAndSpace, run, saveSSpace, setupOptions, usage, verbose, verbose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addExtraOptions

protected void addExtraOptions(ArgOptions options)

Adds options to the provided ArgOptions instance, which will be used to parse the command line. This method allows subclasses the ability to add extra command line options.

Overrides:

addExtraOptions in class GenericMain

Parameters:

options - the ArgOptions object which more main specific options can be added to.

See Also:

GenericMain.handleExtraOptions()

main

public static void main(String[] args)

getSpace

public SemanticSpace getSpace()

Returns the SemanticSpace that will be used for processing. This method is guaranteed to be called after the command line arguments have been parsed, so the contents of GenericMain.argOptions are valid.

Specified by:

getSpace in class GenericMain

getSpaceFormat

protected SemanticSpaceIO.SSpaceFormat getSpaceFormat()

Returns the format in which the finished SemanticSpace should be saved. Subclasses should override this function if they want to specify a specific format that is most suited for their space, when one is not manually specified by the user.

Overrides:

getSpaceFormat in class GenericMain

Returns:

the format in which the semantic space will be saved

setupProperties

public Properties setupProperties()

Returns the Properties object that will be used when calling SemanticSpace.processSpace(Properties). Subclasses should override this method if they need to specify additional properties for the space. This method will be called once before GenericMain.getSpace().

Overrides:

setupProperties in class GenericMain

Returns:

the Properties used for processing the semantic space.