sirius.biz.elastic

Class SearchableEntity

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.BaseEntity<String>

sirius.db.es.ElasticEntity

sirius.biz.elastic.SearchableEntity

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

Direct Known Subclasses:

AuditLogEntry, JournalEntry, LoggedMessage, MailProtocol, StoredIncident

public abstract class SearchableEntity
extends sirius.db.es.ElasticEntity

Maintains a searchField in which all fields annotated with SearchContent are indexed.

While indexing, we also performe some sanity checks like limiting the min and max width of generated tokens.

The tokenizer uses NON_WORD_CHARACTER to separate tokens and them provides them in a whitespace separated format for digestion by Elasticsearch.

Field Summary

Fields

Modifier and Type	Field and Description
static sirius.db.mixing.Mapping	SEARCH_FIELD Contains the actual search data.
static sirius.db.mixing.Mapping	SEARCHABLE_CONTENT Contains manually maintained content to be added to the search field.

Fields inherited from class sirius.db.es.ElasticEntity

elastic, ID

Fields inherited from class sirius.db.mixing.BaseEntity

mixing, NEW, persistedData, version

Fields inherited from class sirius.db.mixing.Mixable

mango, oma

Fields inherited from class sirius.kernel.di.transformers.Composable

components

Constructor Summary

Constructors

Constructor and Description
SearchableEntity()

Method Summary

Modifier and Type	Method and Description
protected void	addContent(StringBuilder contentBuilder, Object propertyValue) Transforms a property value into searchable text.
static void	addContentAsTokens(StringBuilder output, Object value) Tokenizes the given string into the given output builder.
String	getSearchableContent()
String	getSearchField()
void	setSearchableContent(String searchableContent)
protected void	updateSearchField()

Methods inherited from class sirius.db.es.ElasticEntity

getId, getMapper, isUnique, setId

Methods inherited from class sirius.db.mixing.BaseEntity

assertUnique, equals, getDescriptor, getIdAsString, getTypeName, getUniqueName, getVersion, hashCode, isAnyMappingChanged, isChanged, isNew, setVersion, toString

Methods inherited from class sirius.db.mixing.Mixable

is, makeNewInstance, tryAs

Methods inherited from class sirius.kernel.di.transformers.Composable

as, attach, attach

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEARCHABLE_CONTENT

public static final sirius.db.mixing.Mapping SEARCHABLE_CONTENT

Contains manually maintained content to be added to the search field.

SEARCH_FIELD

public static final sirius.db.mixing.Mapping SEARCH_FIELD

Contains the actual search data. This field should be used in search queries but must not be modified manually.

Constructor Detail

SearchableEntity

public SearchableEntity()

Method Detail

updateSearchField

protected void updateSearchField()

addContent

protected void addContent(StringBuilder contentBuilder,
                          Object propertyValue)

Transforms a property value into searchable text.

Parameters:

contentBuilder - the output to write to

propertyValue - the value to transform

addContentAsTokens

public static void addContentAsTokens(StringBuilder output,
                                      Object value)

Tokenizes the given string into the given output builder.

Parameters:

output - the builder to write to

value - the value to tokenize

getSearchableContent

public String getSearchableContent()

setSearchableContent

public void setSearchableContent(String searchableContent)

getSearchField

public String getSearchField()