com.github.liblevenshtein.collection.dictionary.Prefix Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of liblevenshtein-lite Show documentation

A library for spelling-correction based on Levenshtein Automata.

There is a newer version: 3.0.1

package com.github.liblevenshtein.collection.dictionary;

import java.io.Serializable;
import java.util.Objects;

/**
 * Creates a linked list that can be used to traverse an
 * {@link com.github.liblevenshtein.collection.dictionary.Dawg} structure.
 * @author Dylon Edwards
 * @since 2.1.0
 */
public class Prefix implements Serializable {

  private static final long serialVersionUID = 1L;

  /**
   * Current node in the trie.
   */
  private DawgNode node;

  /**
   * Sub-term prefix leading up to this one.  This is used to build the
   * {@link #value()} of the term once a final node is reached.
   */
  private Prefix prevNode;

  /**
   * Label along the edge from the predecessor to {@link #node} up to itself.
   */
  private char label;

  /**
   * Builds a new {@link Prefix} with the initial node of a DAWG structure.  All
   * {@link Prefix}es should branch from this one.
   * @param rootNode Root of the dictionary automaton.
   */
  public Prefix(final DawgNode rootNode) {
    this(rootNode, null, '\0');
  }

  public Prefix(DawgNode node, Prefix prevNode, char label) {
    this.node = node;
    this.prevNode = prevNode;
    this.label = label;
  }

  public DawgNode node() {
    return node;
  }

  public Prefix prevNode() {
    return prevNode;
  }

  public char label() {
    return label;
  }

  /**
   * Value of the string built by traversing the DAWG from its root node to this
   * one, and accumulating the character values of the nodes along the way.
   * @return Value of the string built by traversing the DAWG from its root node
   *   to this one, and accumulating the character values of the nodes along the
   *   way.
   */
  public String value() {
    return buffer().toString();
  }

  /**
   * Buffers the labels along the edges of the previous {@link Prefix}es,
   * beginning from the root node.
   * @return A buffer of the labels along the edges of the previous
   * {@link Prefix}es.
   */
  private StringBuilder buffer() {
    final StringBuilder buffer;

    if (null != prevNode) {
      buffer = prevNode.buffer();
      buffer.append(label);
    }
    else {
      buffer = new StringBuilder();
    }

    return buffer;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    Prefix prefix = (Prefix) o;
    return label == prefix.label &&
            Objects.equals(node, prefix.node) &&
            Objects.equals(prevNode, prefix.prevNode);
  }

  @Override
  public int hashCode() {

    return Objects.hash(node, prevNode, label);
  }
}