Package redis.clients.jedis.search

Class Document

java.lang.Object

redis.clients.jedis.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

Field Summary

Fields

Modifier and Type	Field	Description
private final String	id
private byte[]	payload
private final Map<String,Object>	properties
private double	score
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	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)
Document(String id, Map<String,Object> fields, double score, byte[] payload)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Object	get(String key)	return the property value inside a key
String	getId()
byte[]	getPayload()	Deprecated.
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)	Deprecated.
static Document	load(String id, double score, byte[] payload, List<byte[]> fields, boolean decode)	Deprecated.
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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

id

private final String id

score

private double score

payload

private byte[] payload

properties

private final Map<String,Object> properties

Constructor Details

Document

public Document(String id,
 double score)

Document

public Document(String id)

Document

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

Document

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

Document

@Deprecated
public Document(String id,
 Map<String,Object> fields,
 double score,
 byte[] payload)

Deprecated.

Method Details

getProperties

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

load

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

Deprecated.

load

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

Deprecated.

set

public Document set(String key,
 Object value)

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

getScore

public double getScore()

Returns:

the document's score

getPayload

@Deprecated
public byte[] getPayload()

Deprecated.

setScore

public Document setScore(float score)

Set the document's score

Parameters:

score - new score to set

Returns:

the document itself

getId

public String getId()

Returns:

the document's id

hasProperty

public boolean hasProperty(String key)

toString

public String toString()

Overrides:

toString in class Object