package io.ebean.bean;

import java.io.Serializable;

Identifies a unique node of an object graph.

It represents a location relative to the root of an object graph and specific
to a query and call stack hash.

/**
 * Identifies a unique node of an object graph.
 * <p>
 * It represents a location relative to the root of an object graph and specific
 * to a query and call stack hash.
 * </p>
 */
public final class ObjectGraphNode implements Serializable {

  private static final long serialVersionUID = 2087081778650228996L;

  
Identifies the origin.
/**
   * Identifies the origin.
   */
  private final ObjectGraphOrigin originQueryPoint;

  
The path relative to the root.
/**
   * The path relative to the root.
   */
  private final String path;

  
Create at a sub level.
/**
   * Create at a sub level.
   */
  public ObjectGraphNode(ObjectGraphNode parent, String path) {
    this.originQueryPoint = parent.getOriginQueryPoint();
    this.path = parent.getChildPath(path);
  }

  
Create an the root level.
/**
   * Create an the root level.
   */
  public ObjectGraphNode(ObjectGraphOrigin originQueryPoint, String path) {
    this.originQueryPoint = originQueryPoint;
    this.path = path;
  }

  
Return the origin query point.
/**
   * Return the origin query point.
   */
  public ObjectGraphOrigin getOriginQueryPoint() {
    return originQueryPoint;
  }

  private String getChildPath(String childPath) {
    if (path == null) {
      return childPath;
    } else if (childPath == null) {
      return path;
    } else {
      return path + "." + childPath;
    }
  }

  
Return the path relative to the root.
/**
   * Return the path relative to the root.
   */
  public String getPath() {
    return path;
  }

  @Override
  public String toString() {
    return "origin:" + originQueryPoint + " path[" + path + "]";
  }

  @Override
  public int hashCode() {
    int hc = 92821 * originQueryPoint.hashCode();
    hc = 92821 * hc + (path == null ? 0 : path.hashCode());
    return hc;
  }

  @Override
  public boolean equals(Object obj) {
    if (obj == this) {
      return true;
    }
    if (!(obj instanceof ObjectGraphNode)) {
      return false;
    }

    ObjectGraphNode e = (ObjectGraphNode) obj;
    //noinspection StringEquality
    return ((e.path == path) || (e.path != null && e.path.equals(path)))
      && e.originQueryPoint.equals(originQueryPoint);
  }
}