C# Class ABB.Swum.CheckerRule

The rule to construct the SWUM for checker methods.
Inheritance: UnigramMethodRule
Show file Open project: abb-iss/Swum.NET

Public Methods

Method Description
CheckerRule ( ) : System

Creates a new CheckerRule using default values for data sets.

CheckerRule ( HashSet specialWords, HashSet booleanArgumentVerbs, HashSet nounPhraseIndicators, PositionalFrequencies positionalFrequencies ) : System

Creates a new CheckerRule.

CheckerRule ( PartOfSpeechData posData, Tagger tagger, IdSplitter splitter ) : System

Creates a new CheckerRule.

CheckerRule ( PartOfSpeechData posData, Tagger tagger, IdSplitter splitter, HashSet specialWords, HashSet booleanArgumentVerbs, HashSet nounPhraseIndicators, PositionalFrequencies positionalFrequencies ) : System

Creates a new CheckerRule.

ConstructSwum ( ProgramElementNode node ) : void

Constructs the SWUM for the given node, using this rule.

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

CheckerRule() public method

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

CheckerRule() public method

Creates a new CheckerRule.
public CheckerRule ( 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

CheckerRule() public method

Creates a new CheckerRule.
public CheckerRule ( 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

CheckerRule() public method

Creates a new CheckerRule.
public CheckerRule ( 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

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