C# Class ABB.Swum.NounPhraseRule

The rule to construct the SWUM for a method whose name is a noun phrase.
Inheritance: UnigramMethodRule
Show file Open project: abb-iss/Swum.NET

Public Methods

Method Description
ConstructSwum ( ProgramElementNode node ) : void

Constructs the SWUM for the given node, using this rule.
NounPhraseRule ( ) : System

Creates a new NounPhraseRule using default values for data sets.
NounPhraseRule ( HashSet specialWords, HashSet booleanArgumentVerbs, HashSet nounPhraseIndicators, PositionalFrequencies positionalFrequencies ) : System

Creates a new NounPhraseRule.
NounPhraseRule ( PartOfSpeechData posData, Tagger tagger, IdSplitter splitter ) : System

Creates a new NounPhraseRule.
NounPhraseRule ( PartOfSpeechData posData, Tagger tagger, IdSplitter splitter, HashSet specialWords, HashSet booleanArgumentVerbs, HashSet nounPhraseIndicators, PositionalFrequencies positionalFrequencies ) : System

Creates a new NounPhraseRule.

Protected Methods

Method Description
MakeClassification ( MethodDeclarationNode node ) : bool

Determines whether the given MethodDeclarationNode meets the conditions for this rule. This method assumes that the name is parsed, preamble is stripped, and digits and prepositions are tagged.

Method Details

ConstructSwum() public method

Constructs the SWUM for the given node, using this rule.
public ConstructSwum ( ProgramElementNode node ) : void
node ABB.Swum.Nodes.ProgramElementNode The node to construct SWUM for.
return void

MakeClassification() protected method

Determines whether the given MethodDeclarationNode meets the conditions for this rule. This method assumes that the name is parsed, preamble is stripped, and digits and prepositions are tagged.
protected MakeClassification ( MethodDeclarationNode node ) : bool
node ABB.Swum.Nodes.MethodDeclarationNode The MethodDeclarationNode to test.
return bool

NounPhraseRule() public method

Creates a new NounPhraseRule using default values for data sets.
public NounPhraseRule ( ) : System
return System

NounPhraseRule() public method

Creates a new NounPhraseRule.
public NounPhraseRule ( HashSet specialWords, HashSet booleanArgumentVerbs, HashSet nounPhraseIndicators, PositionalFrequencies positionalFrequencies ) : System
specialWords HashSet A list of words that indicate the method name needs special handling.
booleanArgumentVerbs HashSet A list of verbs that indicate that the boolean arguments to a method should be included in the UnknownArguments list.
nounPhraseIndicators HashSet A list of word that indicate that beginning of a noun phrase.
positionalFrequencies ABB.Swum.WordData.PositionalFrequencies Positional frequency data.
return System

NounPhraseRule() public method

Creates a new NounPhraseRule.
public NounPhraseRule ( PartOfSpeechData posData, Tagger tagger, IdSplitter splitter ) : System
posData ABB.Swum.WordData.PartOfSpeechData The part-of-speech data to use.
tagger Tagger The part-of-speech tagger to use.
splitter IdSplitter The identifier splitter to use.
return System

NounPhraseRule() public method

Creates a new NounPhraseRule.
public NounPhraseRule ( PartOfSpeechData posData, Tagger tagger, IdSplitter splitter, HashSet specialWords, HashSet booleanArgumentVerbs, HashSet nounPhraseIndicators, PositionalFrequencies positionalFrequencies ) : System
posData ABB.Swum.WordData.PartOfSpeechData The part-of-speech data to use.
tagger Tagger The part-of-speech tagger to use.
splitter IdSplitter The identifier splitter to use.
specialWords HashSet A list of words that indicate the method name needs special handling.
booleanArgumentVerbs HashSet A list of verbs that indicate that the boolean arguments to a method should be included in the UnknownArguments list.
nounPhraseIndicators HashSet A list of word that indicate that beginning of a noun phrase.
positionalFrequencies ABB.Swum.WordData.PositionalFrequencies Positional frequency data.
return System