Skip to content

Latest commit

 

History

History
121 lines (83 loc) · 3.09 KB

api.md

File metadata and controls

121 lines (83 loc) · 3.09 KB
Raw

Using the API

Installing

Currently, it is only possible to use language bindings from another Bazel project, as the ODict JAR is not yet on Maven Central and Python's dependency on the shared ODict library makes it difficult to distribute through pip. Fortunately, setting up ODict in another Bazel project is easy.

Just add the following to your WORKSPACE file:

http_archive(
    name = "odict",
    sha256 = "b58fd3432a6f84865c67a16ef6718be12ecd6b9b32c12dfd917c0a899807062f",
    strip_prefix = "odict-1.4.5",
    url = "https://github.com/TheOpenDictionary/odict/archive/1.4.5.tar.gz",
)

load("@odict//bazel:odict_deps.bzl", "odict_deps")

odict_deps()

load("@odict//bazel:odict_extra_deps.bzl", "odict_extra_deps")

odict_extra_deps()

then require either @odict//java or @odict//python in your respective Bazel rules.

If any API usage is unclear, you may be able to get a better idea of how to use the APIs by looking at ODict's unit tests.

Go

ODict is built in Go, so naturally it supports a public API out-of-the-box:

import (
	odict "github.com/TheOpenDictionary/odict/lib"
)

func main() {
	// Write a dictionary from a local ODXML file
	odict.CompileDictionary("mydict.xml")

  // Write an XML string to a binary
	odict.WriteDictionary("<dictionary></dictionary>", "mydict.odict")

  // Read a compiled dictionary into memory
	dict := odict.ReadDictionaryFromPath("mydict.odict")

  odict.IndexDictionary(
    "mydict.odict",
    false // Set to "true" to force-index
  )

  // Search an indexed dictionary by ID
  results := odict.SearchDictionary(
    dict.id,
    "dog",
    false // Set to "true" if you need to match the given word exactly
  )
}

Java

While a standalone Java client for ODict used to exist, it has since been superseded by a Java binding that uses the ODict core's cgo dynamic library that lives in this repo.

Fortunately, the new ODict Java interface is extremely easy to use and will always stay up-to-date with the latest upstream changes to the ODict format.

// Import statement
import org.odict.Dictionary;

void main() {
  // Compile a dictionary
  Dictionary.compile("path/to/file");

  // Write a new dictionary
  Dictionary.write("an XML string", "path/to/output.odict");

  // Load a dictionary
  Dictionary dict = new Dictionary("path/to/dictionary.odict");

  // Lookup an entry by word
  System.out.println(dict.lookup("giraffe"));

  // Index the dictionary
  dict.index();

  // Perform a fuzzy-search
  System.out.println(dict.search("full text"));
}

Python

The Python interface for ODict is similar to that of Java and Go:

# Import statement
from python.odict import Dictionary

def main():
  # Compile a dictionary
  Dictionary.compile("path/to/file")

  # Write a new dictionary
  Dictionary.write("an XML string", "path/to/output.odict")

  # Load a dictionary
  dict = Dictionary("path/to/dictionary.odict")

  # Lookup an entry by word
  print(dict.lookup("giraffe"))

  # Index the dictionary
  dict.index()

  # Perform a fuzzy-search
  print(dict.search("full text"))