edu.ucla.sspace.mains

Class DVWordsiMain

java.lang.Object

edu.ucla.sspace.mains.GenericMain

edu.ucla.sspace.mains.GenericWordsiMain

edu.ucla.sspace.mains.DVWordsiMain

Direct Known Subclasses:

DVRIWordsiMain, DVWCWordsiMain, SelPrefWordsiMain

public class DVWordsiMain
extends GenericWordsiMain

A dependency based executable class for running Wordsi. GenericWordsiMain provides the core command line arguments and functionality. This class provides the following additional arguments:

• Optional
  -p, --pathAcceptor=CLASSNAME Specifies the DependencyPathAcceptor to use when validating paths as features. (Default: UniversalPathAcceptor) -W, --weightingFunction=CLASSNAME Specifies the class that will weight dependency paths. -b, --basisMapping=CLASSNAME Specifies the class that deterine what aspect of a DependencyPath will as a feature in the word space. (Default: WordBasedBasisMapping)

Author:

Keith Stevens

Field Summary

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

argOptions, EXT, isMultiThreaded, verbose

Constructor Summary

Constructors

Constructor and Description
DVWordsiMain()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDocIterators(Collection<Iterator<Document>> docIters, String[] fileNames) Adds DependencyFileDocumentIterators for each file name provided.
protected void	addExtraOptions(ArgOptions options) Adds options to the provided ArgOptions instance, which will be used to parse the command line.
protected void	addFileIterators(Collection<Iterator<Document>> docIters, String[] fileNames) Throws UnsupportedOperationException.
protected DependencyPathAcceptor	getAcceptor()
protected DependencyContextGenerator	getContextGenerator()
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 DependencyPathWeight	getWeighter()
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() Allows subclasses to interact with the SemanticSpace after the space has finished processing all of the text.

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, 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

DVWordsiMain

public DVWordsiMain()

Method Detail

main

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

Throws:

Exception

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()

Description copied from class: GenericMain

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()

Allows subclasses to interact with the SemanticSpace after the space has finished processing all of the text.

Overrides:

postProcessing in class GenericMain

getWeighter

protected DependencyPathWeight getWeighter()

getAcceptor

protected DependencyPathAcceptor getAcceptor()

getContextGenerator

protected DependencyContextGenerator getContextGenerator()

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

addFileIterators

protected void addFileIterators(Collection<Iterator<Document>> docIters,
                    String[] fileNames)
                         throws IOException

Throws UnsupportedOperationException.

Overrides:

addFileIterators in class GenericMain

Throws:

IOException

addDocIterators

protected void addDocIterators(Collection<Iterator<Document>> docIters,
                   String[] fileNames)
                        throws IOException

Adds DependencyFileDocumentIterators for each file name provided.

Overrides:

addDocIterators in class GenericMain

Throws:

IOException