Package org.ametys.cms.data.holder.group

Interface IndexableRepeater

All Superinterfaces:

ModelAwareRepeater, Repeater

All Known Subinterfaces:

ModifiableIndexableRepeater

All Known Implementing Classes:

DefaultModelAwareRepeater, DefaultModifiableModelAwareRepeater

public interface IndexableRepeater
extends ModelAwareRepeater

Interface for indexable repeaters

Method Summary

Modifier and Type	Method	Description
List<? extends IndexableRepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
IndexableRepeaterEntry	getEntry(int position)	Retrieves the repeater entry at the given position.
IndexableDataHolder	getParentDataHolder()	Retrieves the parent of the current Repeater
IndexableDataHolder	getRootDataHolder()	Retrieves the root DataHolder of the current repeater
default List<org.apache.solr.common.SolrInputDocument>	indexData(org.apache.solr.common.SolrInputDocument document, org.apache.solr.common.SolrInputDocument rootDocument, String solrFieldPrefix)	Indexes all data and properties of this Repeater
List<org.apache.solr.common.SolrInputDocument>	indexData(org.apache.solr.common.SolrInputDocument document, org.apache.solr.common.SolrInputDocument rootDocument, String solrFieldPrefix, IndexableDataContext context)	Indexes all data and properties of this Repeater

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.ModelAwareRepeater

dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getModel, hasDifferences, hasDifferences

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.Repeater

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getRepositoryData, getSize, hasEntry, hasToMoveEntries

Method Details

indexData

default List<org.apache.solr.common.SolrInputDocument> indexData(org.apache.solr.common.SolrInputDocument document,
 org.apache.solr.common.SolrInputDocument rootDocument,
 String solrFieldPrefix)
                                                          throws BadItemTypeException

Indexes all data and properties of this Repeater

Parameters:

document - the solr document representing th Repeater

rootDocument - the solr document of the root object.

solrFieldPrefix - the prefix of the solr field

Returns:

additional solr documents that may have been created (ex: repeater entries)

Throws:

BadItemTypeException - if the saxed value's type does not matches the stored data

indexData

List<org.apache.solr.common.SolrInputDocument> indexData(org.apache.solr.common.SolrInputDocument document,
 org.apache.solr.common.SolrInputDocument rootDocument,
 String solrFieldPrefix,
 IndexableDataContext context)
                                                  throws BadItemTypeException

Indexes all data and properties of this Repeater

Parameters:

document - the solr document representing this Repeater

rootDocument - the solr document of the root object.

solrFieldPrefix - the prefix of the solr field

context - The context of the data to index

Returns:

additional solr documents that may have been created (ex: repeater entries)

Throws:

BadItemTypeException - if the saxed value's type does not matches the stored data

getEntries

List<? extends IndexableRepeaterEntry> getEntries()

Description copied from interface: Repeater

Retrieves the repeater entries, sorted by position

Specified by:

getEntries in interface ModelAwareRepeater

Specified by:

getEntries in interface Repeater

Returns:

the repeater entries

getEntry

IndexableRepeaterEntry getEntry(int position)

Description copied from interface: Repeater

Retrieves the repeater entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size to get an entry from the beginning Or the position can an integer between 0 and - the repeater size to get an entry from the end (0 means at the end, -1 means before the last one and so on)

Specified by:

getEntry in interface ModelAwareRepeater

Specified by:

getEntry in interface Repeater

Parameters:

position - the position of the entry to retrieve

Returns:

the repeater entry, null if there is no entry at this position

getParentDataHolder

IndexableDataHolder getParentDataHolder()

Description copied from interface: Repeater

Retrieves the parent of the current Repeater

Specified by:

getParentDataHolder in interface ModelAwareRepeater

Specified by:

getParentDataHolder in interface Repeater

Returns:

the parent of the current Repeater

getRootDataHolder

IndexableDataHolder getRootDataHolder()

Description copied from interface: Repeater

Retrieves the root DataHolder of the current repeater

Specified by:

getRootDataHolder in interface ModelAwareRepeater

Specified by:

getRootDataHolder in interface Repeater

Returns:

the root DataHolder