Package org.ametys.cms.data.type.indexing

Class IndexableElementTypeHelper

java.lang.Object

org.ametys.cms.data.type.indexing.IndexableElementTypeHelper

All Implemented Interfaces:

Component, Serviceable

public class IndexableElementTypeHelper
extends Object
implements Component, Serviceable

Helper for indexable element types

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FULL_EXACT_WS	Full-text with simple white-space tokenization.
static final String	FULL_GENERAL	Full-text field name with general text indexation.
static final String	FULL_PREFIX	Unstemmed full-text field prefix
static final String	FULL_STEMMED_PREFIX	Stemmed full-text field prefix.

Constructor Summary

Constructors

Constructor	Description
IndexableElementTypeHelper()

Method Summary

Modifier and Type	Method	Description
static String	getStringIndexingFieldSuffix(DataContext context)	Retrieves the indexing solr field suffix for type string
static String	getStringTextFieldSuffix(DataContext context)	Retrieves the text solr field suffix for type string
static String	getStringWildcardFieldSuffix(DataContext context)	Retrieves the wildcard solr field suffix for type string
static void	indexFileValue(org.apache.solr.common.SolrInputDocument document, org.apache.solr.common.SolrInputDocument rootObjectDocument, String fieldName, File valueToIndex, DataContext context, Logger logger)	Index the given binary value in a solr document.
static void	indexFulltextValue(org.apache.solr.common.SolrInputDocument document, String text, DataContext context)	Index a full-text value.
static void	indexFulltextValue(org.apache.solr.common.SolrInputDocument currentDocument, org.apache.solr.common.SolrInputDocument ametysObjectDocument, String text, DataContext context)	Index a full-text value.
static void	indexStringValue(org.apache.solr.common.SolrInputDocument document, org.apache.solr.common.SolrInputDocument rootObjectDocument, String fieldName, String valueToIndex, DataContext context, Logger logger)	Index the given string value in a solr document.
static boolean	isEnumerated(DataContext context)	Checks if the data is enumerated (=> if its definition has an enumerator)
static boolean	isStringDataFacetable(DataContext context)	Checks if data of type string is facetable
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

FULL_PREFIX

public static final String FULL_PREFIX

Unstemmed full-text field prefix

See Also:

• Constant Field Values

FULL_STEMMED_PREFIX

public static final String FULL_STEMMED_PREFIX

Stemmed full-text field prefix.

See Also:

• Constant Field Values

FULL_GENERAL

public static final String FULL_GENERAL

Full-text field name with general text indexation.

See Also:

• Constant Field Values

FULL_EXACT_WS

public static final String FULL_EXACT_WS

Full-text with simple white-space tokenization.

See Also:

• Constant Field Values

Constructor Details

IndexableElementTypeHelper

public IndexableElementTypeHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

indexStringValue

public static void indexStringValue(org.apache.solr.common.SolrInputDocument document,
 org.apache.solr.common.SolrInputDocument rootObjectDocument,
 String fieldName,
 String valueToIndex,
 DataContext context,
 Logger logger)

Index the given string value in a solr document.

Parameters:

document - the solr document to index into.

rootObjectDocument - the solr document of the root object.

fieldName - the name of the indexing field

valueToIndex - the value to index

context - the context of the data to index. Can not be null

logger - the logger to log in WARN level in case of the given string is too long and will be truncated

getStringIndexingFieldSuffix

public static String getStringIndexingFieldSuffix(DataContext context)

Retrieves the indexing solr field suffix for type string

Parameters:

context - the indexable data context

Returns:

the indexing solr field suffix for type string

getStringWildcardFieldSuffix

public static String getStringWildcardFieldSuffix(DataContext context)

Retrieves the wildcard solr field suffix for type string

Parameters:

context - the indexable data context

Returns:

the wildcard solr field suffix for type string

getStringTextFieldSuffix

public static String getStringTextFieldSuffix(DataContext context)

Retrieves the text solr field suffix for type string

Parameters:

context - the indexable data context

Returns:

the text solr field suffix for type string

isStringDataFacetable

public static boolean isStringDataFacetable(DataContext context)

Checks if data of type string is facetable

Parameters:

context - the data context

Returns:

true if the type string is facetable, false otherwise

isEnumerated

public static boolean isEnumerated(DataContext context)

Checks if the data is enumerated (=> if its definition has an enumerator)

Parameters:

context - the data context

Returns:

true if the data is enumerated, false otherwise

indexFileValue

public static void indexFileValue(org.apache.solr.common.SolrInputDocument document,
 org.apache.solr.common.SolrInputDocument rootObjectDocument,
 String fieldName,
 File valueToIndex,
 DataContext context,
 Logger logger)

Index the given binary value in a solr document.

Parameters:

document - the solr document to index into.

rootObjectDocument - the solr document of the root object.

fieldName - the name of the indexing field

valueToIndex - the value to index

context - the context of the data to index. Can not be null

logger - the logger to log in WARN level in case of an error occurs while indexing the given binary

indexFulltextValue

public static void indexFulltextValue(org.apache.solr.common.SolrInputDocument currentDocument,
 org.apache.solr.common.SolrInputDocument ametysObjectDocument,
 String text,
 DataContext context)

Index a full-text value.

Parameters:

currentDocument - The current document, can be either the ametys object document itself or a repeater document.

ametysObjectDocument - The parent ametys object document.

text - The text to index.

context - The context of the data to index.

indexFulltextValue

public static void indexFulltextValue(org.apache.solr.common.SolrInputDocument document,
 String text,
 DataContext context)

Index a full-text value.

Parameters:

document - The document to index into.

text - The text to index.

context - The context of the data to index.