| Property Name |
Property Type |
Description |
| CleanKey |
System.Boolean |
If enabled, vocabulary lookups will be performed with all punctuation symbols and control characters removed. As an example, this option could be used to match O'Connor in a lexicon which contains 'oconnor'. |
| EnableTranslation |
System.Boolean |
If enabled, values will be translated to the replacement values specified in the vocabulary. Vocabulary entries may consist of key-value pairs, using the = symbol as a delimiter. For example, the vocabulary
entry OK=Oklahoma indicates that if the value "OK" is found, it should be translated to "Oklahoma". If the vocabulary
entry does not specify a replacement value, then no translation will be performed. |
| Exclusions |
Grooper.Core.EmbeddedLexicon |
Defines an optional set of disallowed values. Any extracted value appearing in this list will be discarded. |
| FuzzyMatchDepth |
System.Int32 |
If set to a value other than 0, specifies that only the top N entries in the lexicon will be considered for fuzzy matching purposes. If set to 0,
fuzzy matching will be performed for all entries in the lexicon. NOTE: Depth limits work best when applied to vocabulary lexicons which are sorted in descending order by frequency. |
| FuzzyMatchMinimumLength |
System.Int32 |
The minimum length of values that will be considered for a fuzzy match. Any value shorter than the configured minimum will not be submitted for fuzzy matching. |
| FuzzyMatchSimilarity |
System.Double |
The percentage of similarity required for a fuzzy match. A value of 100% will disable fuzzy matching. Controls how similar a fuzzy match candidate must be to the extracted value in order for a replacement to occur. |
| FuzzyMatchVocabulary |
Grooper.Core.EmbeddedLexicon |
Defines a vocabulary to be used in place of the main vocabulary for fuzzy matching. By default, when fuzzy matching is enabled, the main vocabulary is used for fuzzy matching. However, if the main vocabulary
is large, it may be desirable for performance reason to restrict fuzzy matching to a smaller list of key values. In such cases,
this property can be used to override the set of lexicon enties used for fuzzy matching. |
| FuzzyMatchWeightings |
Grooper.Core.FuzzyMatchWeightings |
Defines weightings to be used for fuzzy lookups. |
| HasReferenceProperties |
System.Boolean |
Returns true if the object has properties which reference Grooper Node objects. |
| IsEmpty |
System.Boolean |
Returns true if all properties with a ViewableAttribute are set to their default value. |
| IsWriteable |
System.Boolean |
Returns true if the object is writable, or false if it is not. |
| MatchCase |
System.Boolean |
If enabled, the case of the extracted value will be detected, and the detected casing will be applied to the translated output value. |
| Owner |
Grooper.ConnectedObject |
Returns the node that owns the connected object, if any. |
| OwnerNode |
Grooper.GrooperNode |
Returns the node that owns the connected object, if any. |
| PorterStemming |
System.Boolean |
If enabled, the final result will be lower-cased and stemmed to its root form using Porter Stemming. This property affects english documents only. Stemming is the process of reducing inflected words to their word stem, base or root form. Stemming is useful when extracting features for
use in classification of documents or data elements. Below are some stemming examples:
The strings "cats", "catlike", and "catty" reduce to "cat".The strings "stems", "stemmer", "stemming", "stemmed" reduce to "stem".The strings "fishing", "fished", and "fisher" reduce to "fish".The strings "argue", "argued", "argues", "arguing", and "argus" reduce to "argu" (illustrating the case where the stem is not itself a word
or root) but "argument" and "arguments" reduce to the stem "argument". |
| Root |
Grooper.GrooperRoot |
Returns the root node |
| Vocabulary |
Grooper.Core.EmbeddedLexicon |
Defines an optional set of allowed values. If a vocabulary is defined, then any result which does not occur in vocabulary will be discarded. |
| Method Name |
Description |
| ClearCache() |
|
| GetCalc(LanguageCode As String) As EditDistanceCalculator |
| Parameters |
| LanguageCode |
| Type: String |
| |
|
| GetProperties() As PropertyDescriptorCollection |
|
| GetReferences() As List(Of GrooperNode) |
Returns a list of GrooperNode objects referenced in the properties of this object. |
| IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently enabled.
| Parameters |
| PropertyName |
| Type: String |
| The name of the property to determine the enabled state for. |
|
| IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently visible.
| Parameters |
| PropertyName |
| Type: String |
| The name of the property to determine the visible state for. |
|
| IsType(Type As Type) As Boolean |
Returns true if the object is of the type specified, or if it derives from the type specfied.
| Parameters |
| Type |
| Type: Type |
| The type to check. |
|
| Serialize() As String |
Serializes the object. |
| SetDatabase(Database As GrooperDb) |
Sets the database connection of the object.
| Parameters |
| Database |
| Type: GrooperDb |
| |
|
| SetOwner(Owner As ConnectedObject, SkipInitialization As Boolean) |
Sets the owner of the connected object with another object that implements the IConnected interface.
| Parameters |
| Owner |
| Type: ConnectedObject |
| |
| |
| SkipInitialization |
| Type: Boolean |
| |
|
| ToString() As String |
Returns a string value representation of the connected object. |
| ValidateProperties() As ValidationErrorList |
Validates the properties of the object, returning a list of validation errors. |
| ValidateValue(Value As String, FuzzyListMode As Boolean, LanguageCode As String) As LookupResult |
Validates the provided value using filtering settings, and returns the original word or a replacement.
| Parameters |
| Value |
| Type: String |
| The value to validate. |
| |
| FuzzyListMode |
| Type: Boolean |
| |
| |
| LanguageCode |
| Type: String |
| |
|