io.valkey.search

Class Document

java.lang.Object

io.valkey.search.Document

All Implemented Interfaces:

Serializable

public class Document
extends Object
implements Serializable

Document represents a single indexed document or entity in the engine

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Document(String id)
Document(String id, double score)
Document(String id, Map<String,Object> fields)
Document(String id, Map<String,Object> fields, double score)

Method Summary

Modifier and Type	Method and Description
Object	get(String key) return the property value inside a key
String	getId()
Iterable<Map.Entry<String,Object>>	getProperties()
Double	getScore()
String	getString(String key) return the property value inside a key
boolean	hasProperty(String key)
static Document	load(String id, double score, byte[] payload, List<byte[]> fields)
static Document	load(String id, double score, List<byte[]> fields, boolean decode)
Document	set(String key, Object value)
Document	setScore(float score) Set the document's score
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Document

public Document(String id)

Document

public Document(String id,
                double score)

Document

public Document(String id,
                Map<String,Object> fields)

Document

public Document(String id,
                Map<String,Object> fields,
                double score)

Method Detail

getProperties

public Iterable<Map.Entry<String,Object>> getProperties()

load

public static Document load(String id,
                            double score,
                            byte[] payload,
                            List<byte[]> fields)

load

public static Document load(String id,
                            double score,
                            List<byte[]> fields,
                            boolean decode)

getId

public String getId()

Returns:

the document's id

getScore

public Double getScore()

Returns:

the document's score

get

public Object get(String key)

return the property value inside a key

Parameters:

key - key of the property

Returns:

the property value

getString

public String getString(String key)

return the property value inside a key

Parameters:

key - key of the property

Returns:

the property value

hasProperty

public boolean hasProperty(String key)

set

public Document set(String key,
                    Object value)

setScore

public Document setScore(float score)

Set the document's score

Parameters:

score - new score to set

Returns:

the document itself

toString

public String toString()

Overrides:

toString in class Object