IM IBM InfoSphere Global Name Recognition, Version 4.2

NameHunter

The NameHunter class encapsulates the data and operations needed to use the NameHunter.

Syntax

class NameHunter

Description

You must instantiate one of these objects to use the API, and you typically need to instantiate one NameHunter object. This class includes functions to manage the main NameHunter components, such as variants, TAQs, regularization rules, transliteration rules, and score logging. Other objects (SearchList, Searcher, etc.) in the API require a NameHunter instance in their constructors.

Description

A number of convenience functions are also included, such as the ability to obtain the name of a culture of the current version of the API.
  • NameHunter

  • nameScore function

    Reports on the similarity between two names.
  • nameMatch function

    Compares two names and returns true if the names pass the surname, given name, and name thresholds.
  • scoreLoggingOn function

    Enables the NameHunter score log that is used by the nameScore and nameMatch functions.
  • scoreLoggingOff function

    Disables the detailed score log.
  • clearlog() function

    Empties the string where the log details are stored.
  • logString() function

    Returns the contents of the score log as a string.
  • addTaq function

    Adds a single title, affix, or qualifier (TAQ).
  • addTaqVariant

    Adds a single TAQ variant. The taqError string can be used to obtain an explanation of why this function failed.
  • addTaqFactor

    Adds a single TAQ factor.
  • loadTaqFactors

    Loads a list of TAQ factors from a file. If the file cannot be opened, an exception is thrown.
  • taqError function

    Use taqError to obtain an explanation if the addTaq function returns false.
  • defaultMaxResults function

    Default max results for a search operation.
  • loadTaqs function

    Loads a list of titles, affixes, and qualifiers (TAQ)s.
  • loadTaqVariants

    Loads a list of TAQ variants from a file. A run time exception is thrown if an error is found, such as an invalid culture code.
  • loadTerms function

    Loads a list of terms from a file.
  • addTerm function

    Adds a single term.
  • loadAllTaqInfo

    Loads all TAQ information (TAQs, TAQ variants, and TAQ factors) from a single file instead of having to call the three separate functions to load the TAQ information separately.
  • addVariant function

    Adds a single variant.
  • variantError function

    Use variantError() to get an explanation if the addVariant function returns false.
  • loadVariants function

    Use to load a list of variants.
  • loadRegRules function

    Loads IBM-supplied rules to produce a normalized form of the name.
  • regularize function

    Produces a normalized version of a name. NameHunter recognizes non-ASCII characters and converts these characters to an internal format suitable for name matching.
  • loadTransRules function

    Loads a transliteration rules file.
  • transliterate function

    Allows NameHunter to understand non-Roman scripts, such as, Arabic.
  • cultureName function

    Convenience function to retrieve the name of a culture.
  • version function

    Retrieves the string for the NameHunter version number and build date.
Parent topic: NameHunter (LAS::NH class)


Feedback