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

Class IndexableDataContext

java.lang.Object

org.ametys.runtime.model.type.DataContext

org.ametys.plugins.repository.model.RepositoryDataContext

org.ametys.cms.data.type.indexing.IndexableDataContext

public class IndexableDataContext
extends RepositoryDataContext

Object that gives some context for data indexation manipulation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IndexableDataContext()	Creates a new instance of a IndexableDataContext
protected	IndexableDataContext(DataContext context)	Creates a new instance of a IndexableDataContext from another DataContext

Method Summary

Modifier and Type	Method	Description
IndexableDataContext	cloneContext()	Creates a new instance of a IndexableDataContext, with the current context values
String	getFullTextFieldName()	Get the field name of full-text field.
boolean	indexForFullTextField()	Determines if the value should be indexed for a fulltext field.
static IndexableDataContext	newInstance()	Creates a new instance of a IndexableDataContext
static IndexableDataContext	newInstance(DataContext context)	Creates a new instance of a IndexableDataContext from another DataContext.
<T extends IndexableDataContext> T	withFullTextFieldName(String fulltextFieldName)	Set the field name of full-text field.
<T extends IndexableDataContext> T	withIndexForFullTextField(boolean indexForFullTextField)	Set to true to index the value for a fulltext field.

Methods inherited from class org.ametys.plugins.repository.model.RepositoryDataContext

getExternalizableData, isDataExternalizable, withExternalizableData

Methods inherited from class org.ametys.runtime.model.type.DataContext

addSegmentToDataPath, addSuffixToLastSegment, getDataPath, getDataPathLastSegment, getFullDataPath, getLocale, getModelItem, getObjectId, getRootObjectId, getViewItem, renderEmptyValues, withDataPath, withEmptyValues, withFullDataPath, withLocale, withModelItem, withObjectId, withRootObjectId, withViewItem

Methods inherited from class java.lang.Object

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

Constructor Details

IndexableDataContext

protected IndexableDataContext()

Creates a new instance of a IndexableDataContext

IndexableDataContext

protected IndexableDataContext(DataContext context)

Creates a new instance of a IndexableDataContext from another DataContext

Parameters:

context - the data context to copy

Method Details

newInstance

public static IndexableDataContext newInstance()

Creates a new instance of a IndexableDataContext

Returns:

the created instance

newInstance

public static IndexableDataContext newInstance(DataContext context)

Creates a new instance of a IndexableDataContext from another DataContext. It can be the same implementation or another one, but it will be casted to the current implementation.

Parameters:

context - the data context to copy

Returns:

the created instance

cloneContext

public IndexableDataContext cloneContext()

Creates a new instance of a IndexableDataContext, with the current context values

Overrides:

cloneContext in class RepositoryDataContext

Returns:

the created instance

indexForFullTextField

public boolean indexForFullTextField()

Determines if the value should be indexed for a fulltext field. The fulltext field is given by this IndexableDataContext

Returns:

true to index value for a fulltext field, false otherwise.

withIndexForFullTextField

public <T extends IndexableDataContext> T withIndexForFullTextField(boolean indexForFullTextField)

Set to true to index the value for a fulltext field. The fulltext field is given by this IndexableDataContext

Parameters:

indexForFullTextField - true to index the value for a fulltext field, false otherwise

Returns:

the current IndexableDataContext

getFullTextFieldName

public String getFullTextFieldName()

Get the field name of full-text field. Use if this IndexableDataContext is instanciated for full-text field

Returns:

the field name of full-text field. Default to SolrFieldNames.SYSTEM_FULL

withFullTextFieldName

public <T extends IndexableDataContext> T withFullTextFieldName(String fulltextFieldName)

Set the field name of full-text field. Use if this IndexableDataContext is instanciated for full-text field

Parameters:

fulltextFieldName - the full-text field name

Returns:

the current IndexableDataContext