redis.clients.jedis.search.Document Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jedis Show documentation
Jedis is a blazingly small and sane Redis java client.
There is a newer version: 5.2.0
package redis.clients.jedis.search;

import redis.clients.jedis.util.SafeEncoder;

import java.io.Serializable;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import redis.clients.jedis.Builder;
import redis.clients.jedis.BuilderFactory;
import redis.clients.jedis.util.KeyValue;

/**
 * Document represents a single indexed document or entity in the engine
 */
public class Document implements Serializable {

  private static final long serialVersionUID = 4884173545291367373L;

  private final String id;
  private Double score;
  private final Map fields;

  public Document(String id) {
    this(id, 1.0);
  }

  public Document(String id, double score) {
    this(id, new HashMap<>(), score);
  }

  public Document(String id, Map fields) {
    this(id, fields, 1.0f);
  }

  public Document(String id, Map fields, double score) {
    this.id = id;
    this.fields = fields;
    this.score = score;
  }

  private Document(String id, Double score, Map fields) {
    this.id = id;
    this.score = score;
    this.fields = fields;
  }

  public Iterable> getProperties() {
    return fields.entrySet();
  }

  public static Document load(String id, double score, byte[] payload, List fields) {
    return Document.load(id, score, fields, true);
  }

  public static Document load(String id, double score, List fields, boolean decode) {
    Document ret = new Document(id, score);
    if (fields != null) {
      for (int i = 0; i < fields.size(); i += 2) {
        byte[] rawKey = fields.get(i);
        byte[] rawValue = fields.get(i + 1);
        String key = SafeEncoder.encode(rawKey);
        Object value = rawValue == null ? null : decode ? SafeEncoder.encode(rawValue) : rawValue;
        ret.set(key, value);
      }
    }
    return ret;
  }

  /**
   * @return the document's id
   */
  public String getId() {
    return id;
  }

  /**
   * @return the document's score
   */
  public Double getScore() {
    return score;
  }

  /**
   * return the property value inside a key
   *
   * @param key key of the property
   *
   * @return the property value
   */
  public Object get(String key) {
    return fields.get(key);
  }

  /**
   * return the property value inside a key
   *
   * @param key key of the property
   *
   * @return the property value
   */
  public String getString(String key) {
    Object value = fields.get(key);
    if (value instanceof String) {
      return (String) value;
    }
    return value instanceof byte[] ? SafeEncoder.encode((byte[]) value) : value.toString();
  }

  public boolean hasProperty(String key) {
    return fields.containsKey(key);
  }

  public Document set(String key, Object value) {
    fields.put(key, value);
    return this;
  }

  /**
   * Set the document's score
   *
   * @param score new score to set
   * @return the document itself
   */
  public Document setScore(float score) {
    this.score = (double) score;
    return this;
  }

  @Override
  public String toString() {
    return "id:" + this.getId() + ", score: " + this.getScore() +
            ", properties:" + this.getProperties();
  }

  static Builder SEARCH_DOCUMENT = new Builder() {

    private static final String ID_STR = "id";
    private static final String SCORE_STR = "score";
    // private static final String FIELDS_STR = "fields";
    private static final String FIELDS_STR = "extra_attributes";

    @Override
    public Document build(Object data) {
      List list = (List) data;
      String id = null;
      Double score = null;
      Map fields = null;
      for (KeyValue kv : list) {
        String key = BuilderFactory.STRING.build(kv.getKey());
        switch (key) {
          case ID_STR:
            id = BuilderFactory.STRING.build(kv.getValue());
            break;
          case SCORE_STR:
            score = BuilderFactory.DOUBLE.build(kv.getValue());
            break;
          case FIELDS_STR:
            fields = BuilderFactory.ENCODED_OBJECT_MAP.build(kv.getValue());
            break;
        }
      }
//      assert id != null;
//      if (fields == null) fields = Collections.emptyMap();
      return new Document(id, score, fields);
    }
  };
}