edu.ucla.sspace.mains

Class GrefenstetteMain

java.lang.Object

edu.ucla.sspace.mains.GenericMain

edu.ucla.sspace.mains.GrefenstetteMain

public class GrefenstetteMain
extends GenericMain

An executable class for running Grefenstette algorithm from the command line. This class provides several options:

• Required (at least one of):
  • -s, --sentenceFile=FILE[,FILE...] a file where each line is a single sentence
• Program Options:
  • -o, --outputFormat=text|binary} Specifies the output formatting to use when generating the semantic space (.sspace) file. See SemanticSpaceUtils for format details.
  • -v, --verbose prints verbose output
  • -w, --overwrite=BOOL specifies whether to overwrite the existing output

An invocation will produce one file as output greffenstette.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 greffenstette<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.

Author:

Grace Park

See Also:

Grefenstette

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) Currently adds no extra options
protected Iterator<Document>	getDocumentIterator() Returns the iterator for all of the documents specified on the command line or throws an Error if no documents are specified.
SemanticSpace	getSpace() Returns an instance of the Grefenstette algorithm.
static void	main(String[] args)
protected ArgOptions	setupOptions() Adds the options for running the Grefenstette algorithm

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

addCorpusReaderIterators, addDocIterators, addFileIterators, getAlgorithmSpecifics, getSpaceFormat, handleExtraOptions, loadValidTermSet, parseDocumentsMultiThreaded, parseDocumentsSingleThreaded, postProcessing, processDocumentsAndSpace, run, saveSSpace, setupProperties, usage, verbose, verbose

Methods inherited from class java.lang.Object

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

Method Detail

setupOptions

protected ArgOptions setupOptions()

Adds the options for running the Grefenstette algorithm

Overrides:

setupOptions in class GenericMain

addExtraOptions

protected void addExtraOptions(ArgOptions options)

Currently adds no extra options

Overrides:

addExtraOptions in class GenericMain

Parameters:

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

See Also:

GenericMain.handleExtraOptions()

getDocumentIterator

protected Iterator<Document> getDocumentIterator()
                                          throws IOException

Description copied from class: GenericMain

Returns the iterator for all of the documents specified on the command line or throws an Error if no documents are specified. If subclasses should override either GenericMain.addFileIterators(java.util.Collection<java.util.Iterator<edu.ucla.sspace.text.Document>>, java.lang.String[]) or GenericMain.addDocIterators(java.util.Collection<java.util.Iterator<edu.ucla.sspace.text.Document>>, java.lang.String[]) if they use different file format. Alternatively, oen can implement a CorpusReader and use the -R option.

Overrides:

getDocumentIterator in class GenericMain

Throws:

IOException

getSpace

public SemanticSpace getSpace()

Returns an instance of the Grefenstette algorithm.

Specified by:

getSpace in class GenericMain

main

public static void main(String[] args)