edu.ucla.sspace.mains

Class LpsaMain

java.lang.Object

edu.ucla.sspace.mains.GenericMain

edu.ucla.sspace.mains.LpsaMain

public class LpsaMain
extends GenericMain

An executable class for running LocalityPreservingSemanticAnalysis (LPSA) from the command line.

An invocation will produce one file as output lpsa-semantic-space.sspace. If overwrite was set to true, this file will be replaced for each new semantic space. Otherwise, a new output file of the format lpsa-semantic-space<number>.sspace will be created, where <number> is a unique identifier for that program's invocation. The output file will be placed in the directory specified on the command line.

This class is desgined to run multi-threaded and performs well with one thread per core, which is the default setting.

Author:

David Jurgens

See Also:

LocalityPreservingSemanticAnalysis, Transform

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 all of the options to the ArgOptions.
protected String	getAlgorithmSpecifics() Returns a string describing algorithm-specific options and behaviods.
protected SemanticSpace	getSpace() Returns the SemanticSpace that will be used for processing.
protected SemanticSpaceIO.SSpaceFormat	getSpaceFormat() Returns the format as the default format of a LocalityPreservingSemanticAnalysis space.
static void	main(String[] args)
protected 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, 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 all of the options to the ArgOptions.

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

protected SemanticSpace getSpace()

Description copied from class: GenericMain

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 as the default format of a LocalityPreservingSemanticAnalysis space.

Overrides:

getSpaceFormat in class GenericMain

Returns:

the format in which the semantic space will be saved

setupProperties

protected Properties setupProperties()

Description copied from class: GenericMain

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.

getAlgorithmSpecifics

protected String getAlgorithmSpecifics()

Returns a string describing algorithm-specific options and behaviods. This string will be printed before the default option details

Overrides:

getAlgorithmSpecifics in class GenericMain