Name class

The Name class provides an interface to manipulate name information. The class represents names that are input either as a query name or as a data list name from an input file. The Name class provides access to the name fields, culture information, and NameCategory of the name.

Syntax

class Name
{
 Name
 (
  const   std::string& sn,
  const   std::string& gn,
  const   std::string& data,
  Culture cultureSn = CultureUnknown,
  Culture cultureGn = CultureUnknown
 );

Syntax

 Name
 (
  const   std::string& on,
  const   std::string& data,
  Culture cultureOn = CultureUnknown
 );

  std::string  getGivenName() const;
  std::string  getSurname()   const;
  std::string  getPersonalName() const;
  std::string  getOrgName() const;
  Culture      getGivenNameCulture() const;
  Culture      getSurnameCulture() const;
  Culture      getOrgNameCulture() const;
  NameCategory getCategory() const;
  bool         isPersonal() const;
  bool         isOrganization() const;

Description

The creation of Name objects requires access to the current scoring configuration that performs categorization, parsing, and culture classification of data. The Name object is used to return results of operations and details such as multiple culture associations and parse confidence values that are name-specific members of Name.

const std::string& sn: Constructs a surname for a Personal name.
const std::string& gn: Constructs a given name for a Personal name.
const std::string& on: Constructs an Organization name.

getGivenName(): Returns the text for the given name field.
getSurname(): Returns the surname field.
getPersonalName(): Returns the text that is associated with a Personal name.
getOrgName(): Returns the text that is associated with an Organization name.
getData(): Obtains the supplementary data that is associated with a specific name record. In the case of unique name searching, this value contains the key used to retrieve supplementary data for all name records associated with this unique name.
getGivenNameCulture(): Returns a culture code for the given name.
getSurnameCulture(): Returns a culture code for the surname.
getOrgNameCulture(): Returns a culture code for an Organization name. The default culture code for Organization names is Unknown.
getCategory(): Returns the name category value. Valid name categories are Personal and Organization.
isPersonal() | isOrganization(): Returns a flag indicating that a name is categorized as Personal or Organization.