edu.ucla.sspace.mains

Class DependencyVectorSpaceMain

java.lang.Object

edu.ucla.sspace.mains.GenericMain

edu.ucla.sspace.mains.DependencyGenericMain

edu.ucla.sspace.mains.DependencyVectorSpaceMain

public class DependencyVectorSpaceMain
extends DependencyGenericMain

An executable class for running DepenencyVectorSpace from the command line. An invocation will produce one file as output structued-vector-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 dependency-vector-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:

DependencyVectorSpace

Field Summary

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

argOptions, EXT, isMultiThreaded, verbose

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtraOptions(ArgOptions options) Adds options to the provided ArgOptions instance, which will be used to parse the command line.
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 in which the finished SemanticSpace should be saved.
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.DependencyGenericMain

addDocIterators, addFileIterators, setupDependencyExtractor, usage

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

addCorpusReaderIterators, getDocumentIterator, handleExtraOptions, loadValidTermSet, parseDocumentsMultiThreaded, parseDocumentsSingleThreaded, postProcessing, processDocumentsAndSpace, run, saveSSpace, setupOptions, verbose, verbose

Methods inherited from class java.lang.Object

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

Method Detail

addExtraOptions

public 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 DependencyGenericMain

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)

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

getSpace

protected 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

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

setupProperties

protected 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.