de.hybris.platform.lucenesearch.jalo

Class IndexedData

java.lang.Object

de.hybris.platform.lucenesearch.jalo.IndexedData

public class IndexedData
extends Object

Used to collect all indexed text fields of an item during index (re)building. This object is created by implementations of IndexedDataFactory within IndexedDataFactory.getIndexedData(IndexConfiguration, Collection) and IndexedDataFactory.getIndexedData(IndexConfiguration, Collection). Broadly it represents one lucene document including several fields. These fields provide a boost factor and a tokenizing flag. Here localized and unlocalized fields are still kept together - the actual lucene index will put the into different index directories later.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IndexedData.AttributeValue Represents a single field within a IndexedData record.

Constructor Summary

Constructors

Constructor and Description
IndexedData(PK typePK, PK pk) Creates a new lucene index representation for a specified item.

Method Summary

Modifier and Type	Method and Description
void	addGroup(String groupID) Deprecated. this has been used for filtering by item type - simply add a search term for the field 'type' to do this
void	addLocalized(PK languagePK, String qualifier, String text, Double weight, boolean exact) Deprecated. use {addLocalized(PK, String, String, Double, boolean, boolean) instead
IndexedData.AttributeValue	addLocalized(PK languagePK, String qualifier, String text, Double weight, boolean exact, boolean storeData) Adds a localized text to a specified (attribute) field.
void	addUnlocalized(String qualifier, String text, Double weight, boolean exact) Deprecated. use {addUnlocalized(String, String, Double, boolean, boolean) instead.
IndexedData.AttributeValue	addUnlocalized(String qualifier, String text, Double weight, boolean exact, boolean storeData) Adds a unlocalized text to a specified (attribute) field.
Map<PK,Collection<IndexedData.AttributeValue>>	getAllValues() Provides access to all stored attribute values inside this object.
List<String>	getGroups() Deprecated.
protected IndexedData.AttributeValue	getLocalizedValue(PK langPK, String fieldName) Returns a single localized field for a given language and field qualifier or null if the field does not exist within this record.
PK	getPK() Returns the item pk of the indexed record.
PK	getTypePK() Returns the type PK of the indexed record.
protected IndexedData.AttributeValue	getUnlocalizedValue(String fieldName) Returns a single unlocalized field or null if no such field exists within this record.
Collection<IndexedData.AttributeValue>	getValues(PK langPK) Returns all indexed fields for a given language.
protected List<String>	groups(boolean create)
void	remove(IndexedData.AttributeValue value) Removes a given attribute value from this container.
void	removeLocalized(PK languagePK, String qualifier) Removes all localized values for a given language and field qualifier
void	removeUnlocalized(String qualifier) Removes all unlocalized values for a given field qualifier.
String	toString() returns a string with the layout "IndexedData for {pk} [unlocalized={unlocalized}; localized={localized}; groups={groups}]";
protected List<IndexedData.AttributeValue>	values(boolean create)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedData

public IndexedData(PK typePK,
                   PK pk)

Creates a new lucene index representation for a specified item.

Parameters:

typePK - the pk of this item's ComposedType

pk - the pk of the item

Method Detail

getPK

public PK getPK()

Returns the item pk of the indexed record.

getTypePK

public PK getTypePK()

Returns the type PK of the indexed record.

values

protected List<IndexedData.AttributeValue> values(boolean create)

groups

protected List<String> groups(boolean create)

getGroups

@Deprecated
public List<String> getGroups()

Deprecated.

Originally used to limiting item records by their type. Now this can be done by simply adding a search term for the default 'type' field.

addUnlocalized

@Deprecated
public void addUnlocalized(String qualifier,
                                       String text,
                                       Double weight,
                                       boolean exact)

Deprecated. use {addUnlocalized(String, String, Double, boolean, boolean) instead.

addUnlocalized

public IndexedData.AttributeValue addUnlocalized(String qualifier,
                                                 String text,
                                                 Double weight,
                                                 boolean exact,
                                                 boolean storeData)

Adds a unlocalized text to a specified (attribute) field. In case the same field had been added before the text value is appended to it. Otherwise a new field is created here.

Parameters:

qualifier - the field resp. attribute qualifier

text - the text to add to the index

weight - the field weight to boost importance of matches within this field

exact - if true the field value is not tokenized, meaning it will not be processed by any analyzer or tokenizer. the index will store it unchanged

Returns:

the newly created value or the existing one with the same qualifier

getValues

public Collection<IndexedData.AttributeValue> getValues(PK langPK)

Returns all indexed fields for a given language. This includes all values which either match the given language or have no language at all.

Parameters:

langPK - the PK of the Language to get fields for

getAllValues

public Map<PK,Collection<IndexedData.AttributeValue>> getAllValues()

Provides access to all stored attribute values inside this object.

The result map contains language PKs and their associated values. Please note that all unlocalized values are mapped to the null language PK.

getLocalizedValue

protected IndexedData.AttributeValue getLocalizedValue(PK langPK,
                                                       String fieldName)

Returns a single localized field for a given language and field qualifier or null if the field does not exist within this record.

Parameters:

langPK - the pk of the Language to get fields for

fieldName - the field name

getUnlocalizedValue

protected IndexedData.AttributeValue getUnlocalizedValue(String fieldName)

Returns a single unlocalized field or null if no such field exists within this record.

Parameters:

fieldName - the field name

addLocalized

@Deprecated
public void addLocalized(PK languagePK,
                                     String qualifier,
                                     String text,
                                     Double weight,
                                     boolean exact)

Deprecated. use {addLocalized(PK, String, String, Double, boolean, boolean) instead

addLocalized

public IndexedData.AttributeValue addLocalized(PK languagePK,
                                               String qualifier,
                                               String text,
                                               Double weight,
                                               boolean exact,
                                               boolean storeData)

Adds a localized text to a specified (attribute) field. In case the same field had been added before the text value is appended to it. Otherwise a new field is created here.

Parameters:

languagePK - the Language pk which the value belongs to

qualifier - the field resp. attribute qualifier

text - the text to add to the index

weight - the field weight to boost importance of matches within this field

exact - if true the field value is not tokenized, meaning it will not be processed by any analyzer or tokenizer. the index will store it unchanged

Returns:

the newly created value or the existing one with the same qualifier

remove

public void remove(IndexedData.AttributeValue value)

Removes a given attribute value from this container.

removeUnlocalized

public void removeUnlocalized(String qualifier)

Removes all unlocalized values for a given field qualifier.

Parameters:

qualifier - the field qualifier

removeLocalized

public void removeLocalized(PK languagePK,
                            String qualifier)

Removes all localized values for a given language and field qualifier

Parameters:

languagePK - the language PK

qualifier - the field qualifier

addGroup

@Deprecated
public void addGroup(String groupID)

Deprecated. this has been used for filtering by item type - simply add a search term for the field 'type' to do this

Adds the indexed item to the given group.

See Also:

LucenesearchManager for a description of grouping

toString

public String toString()

returns a string with the layout "IndexedData for {pk} [unlocalized={unlocalized}; localized={localized}; groups={groups}]";

Overrides:

toString in class Object