Package de.cxp.ocs.model.index

Class Document

java.lang.Object

de.cxp.ocs.model.index.Document

Direct Known Subclasses:

Product

public class Document
extends Object

A simple 'data record' similar to a row inside a CSV file that contains any data relevant for search. The single field types and conversions are part of the according service configuration.

Field Summary

Fields

Modifier and Type	Field	Description
List<Attribute>	attributes
List<Category[]>	categories	Deprecated.
Map<String,Object>	data
@NonNull String	id

Constructor Summary

Constructors

Constructor	Description
Document()

Method Summary

Modifier and Type	Method	Description
Document	addAttribute(Attribute attr)
Document	addCategory(Category... values)	Deprecated. use addPath with a specific name.
Document	addPath(String name, Category... values)	Add a hierarchical path for a given field name.
Document	set(String name, double... values)
Document	set(String name, int... values)
Document	set(String name, long... values)
Document	set(String name, String... values)
Document	setAttributes(Attribute... values)

Methods inherited from class java.lang.Object

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

Field Details

id

@NonNull
public @NonNull String id

data

public Map<String,Object> data

attributes

public List<Attribute> attributes

categories

@Deprecated
public List<Category[]> categories

Deprecated.

Constructor Details

Document

public Document()

Method Details

set

public Document set(String name,
 String... values)

set

public Document set(String name,
 long... values)

set

public Document set(String name,
 int... values)

set

public Document set(String name,
 double... values)

addPath

public Document addPath(String name,
 Category... values)

Add a hierarchical path for a given field name. This is usable in case you have multiple different category trees.

Parameters:

name - field name

values - single path hierarchy

Returns:

the modified document (fluent return)

setAttributes

public Document setAttributes(Attribute... values)

addAttribute

public Document addAttribute(Attribute attr)

addCategory

@Deprecated
public Document addCategory(Category... values)

Deprecated.

use addPath with a specific name. For legacy usage, use the field name used in the according indexer field configuration.

Parameters:

values - single path

Returns:

modified document (fluent return)