Homophone dictionary

The HomophoneDictionary class is designed to store homophones in an index. For information on searching using homophones, see the Homophone search page.

To get the number of homophones in the dictionary, use the getCount method.

To add groups of homophones to the dictionary, use the addRange method.

The clear method is used to remove all homophones from the dictionary.

The getHomophones method is used to get a list of synonyms for a given word.

The getHomophoneGroups method is used to get all synonym groups to which a given word belongs.

To get all synonym groups from the dictionary, use the getAllHomophoneGroups method.

To export homophones to a file, use the exportDictionary method.

To import homophones from a file, use the importDictionary method.

The following example demonstrates the use of methods of the homophone dictionary.

const indexFolder = 'c:/MyIndex/';
const documentsFolder = 'c:/MyDocuments/';

// Creating an index from in specified folder
const index = new groupdocs.search.Index(indexFolder);

// Indexing documents from the specified folder
index.add(documentsFolder);

// Getting homophones for word 'braid'
const homophones = index.getDictionaries().getHomophoneDictionary().getHomophones('braid');
console.log("Homophones for 'braid':");
for (const homophone of homophones) {
  console.log(homophone);
}

// Getting groups of homophones to which word 'braid' belongs to
const groups = index.getDictionaries().getHomophoneDictionary().getHomophoneGroups('braid');
console.log("Homophone groups for 'braid':");
for (const group of groups) {
  for (const group1 of group) {
    console.log(group1 + ' ');
  }
  console.log();
}

if (index.getDictionaries().getHomophoneDictionary().getCount() > 0) {
  // Removing all homophones from the dictionary
  index.getDictionaries().getHomophoneDictionary().clear();
}

// Adding homophones to the dictionary
const homophoneGroups = java.newInstanceSync('java.util.ArrayList');
homophoneGroups.add(java.newArray('java.lang.String', ['awe', 'oar', 'or', 'ore']));
homophoneGroups.add(java.newArray('java.lang.String', ['aye', 'eye', 'i']));
homophoneGroups.add(java.newArray('java.lang.String', ['call', 'caul']));
index.getDictionaries().getHomophoneDictionary().addRange(homophoneGroups);

// Export homophones to a file
const fileName = Utils.OutputPath + 'AdvancedUsage/ManagingDictionaries/homophoneDictionary/Homophones.dat';
index.getDictionaries().getHomophoneDictionary().exportDictionary(fileName);

// Import homophones from a file
index.getDictionaries().getHomophoneDictionary().importDictionary(fileName);

// Search in the index
const query = 'caul';
const options = new groupdocs.search.SearchOptions();
options.setUseHomophoneSearch(true);
const result = index.search(query, options);

More resources

GitHub examples

You may easily run the code from documentation articles and see the features in action in our GitHub examples:

Free online document search App

Along with full featured .NET library we provide simple, but powerful free Apps.

You are welcome to search over your PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX and more with our free online Free Online Document Search App.