edu.ucla.sspace.mains

Class RIWordsiMain

java.lang.Object

edu.ucla.sspace.mains.GenericMain

edu.ucla.sspace.mains.GenericWordsiMain

edu.ucla.sspace.mains.RIWordsiMain

public class RIWordsiMain
extends GenericWordsiMain

An executiable class for running Wordsi with a RandomIndexingContextGenerator.

The core command line arguments are provided by GenericWordsiMain. This class takes in the following additional arguments:

• Required:
  -l, --indexVectorLength=INT Specifies the length of index vectors
  • Optional:
    -p, --permFunction=CLASSNAME Specifies the permutation function to apply on index vectors. (Default: none).
  When using the --Save option, this class will save a mapping from strings to TernaryVectors. When using the --Load option, this class will load a mapping from strings to TernaryVectors from disk. This mapping may be a GeneratorMap or it may be a fixed Map. If --Save is not used, a GeneratorMap will be used for creating TernaryVectors.

Author:

Keith Stevens

See Also:

GenericWordsiMain, RandomIndexingContextGenerator

Field Summary

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

argOptions, EXT, isMultiThreaded, verbose

Constructor Summary

Constructors

Constructor and Description
RIWordsiMain()

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.
protected ContextExtractor	getExtractor() Returns a ContextExtractor, which will be responsible for creating context vectors for documents.
protected SemanticSpaceIO.SSpaceFormat	getSpaceFormat() Returns the format in which the finished SemanticSpace should be saved.
protected void	handleExtraOptions() Once the command line has been parsed, allows the subclasses to perform additional steps based on class-specific options.
static void	main(String[] args)
protected void	postProcessing() Saves the index map to disk.

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

contextExtractorFromGenerator, getAcceptedWords, getDocumentIterator, getPseudoWordMap, getSpace, loadObject, openLoadFile, openSaveFile, saveObject, windowSize

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

addCorpusReaderIterators, addDocIterators, addFileIterators, getAlgorithmSpecifics, loadValidTermSet, parseDocumentsMultiThreaded, parseDocumentsSingleThreaded, processDocumentsAndSpace, run, saveSSpace, setupOptions, setupProperties, usage, verbose, verbose

Methods inherited from class java.lang.Object

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

Constructor Detail

RIWordsiMain

public RIWordsiMain()

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 GenericWordsiMain

Parameters:

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

See Also:

GenericMain.handleExtraOptions()

handleExtraOptions

protected void handleExtraOptions()

Once the command line has been parsed, allows the subclasses to perform additional steps based on class-specific options. This method will be called before getSpace..

Overrides:

handleExtraOptions in class GenericMain

See Also:

GenericMain.addExtraOptions(ArgOptions)

postProcessing

protected void postProcessing()

Saves the index map to disk.

Overrides:

postProcessing in class GenericMain

getExtractor

protected ContextExtractor getExtractor()

Returns a ContextExtractor, which will be responsible for creating context vectors for documents.

Specified by:

getExtractor in class GenericWordsiMain

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

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception