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

Class DefaultIndexableRepeater

java.lang.Object

org.ametys.plugins.repository.data.holder.group.impl.DefaultRepeater

org.ametys.cms.data.holder.group.impl.DefaultIndexableRepeater

All Implemented Interfaces:

IndexableRepeater, Repeater

public class DefaultIndexableRepeater
extends DefaultRepeater
implements IndexableRepeater

Class for indexable model aware repeaters

Field Summary

Fields inherited from class org.ametys.plugins.repository.data.holder.group.impl.DefaultRepeater

_definition, _parent, _repositoryData, _root

Constructor Summary

Constructors

Constructor	Description
DefaultIndexableRepeater(RepositoryData repositoryData, RepeaterDefinition definition, IndexableDataHolder parent, IndexableDataHolder root)	Creates a default indexable repeater

Method Summary

Modifier and Type	Method	Description
protected IndexableRepeaterEntry	createRepeaterEntryInstance(RepositoryData entryRepositoryData)	Creates an instance of RepeaterEntry to use
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
List<org.apache.solr.common.SolrInputDocument>	indexData(org.apache.solr.common.SolrInputDocument document, org.apache.solr.common.SolrInputDocument rootDocument, String solrFieldPrefix, CMSDataContext context)	Indexes all data and properties of this Repeater

Methods inherited from class org.ametys.plugins.repository.data.holder.group.impl.DefaultRepeater

copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDifferences, getDifferencesInAppendMode, getDifferencesInReplaceAllMode, getDifferencesInReplaceMode, getEntryAttributes, getModel, getRepositoryData, getSize, hasDifferences, hasDifferencesInAppendMode, hasDifferencesInReplaceAllMode, hasDifferencesInReplaceMode, hasEntry, hasToMoveEntries

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.data.holder.group.IndexableRepeater

indexData

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDifferences, getDifferences, getModel, getRepositoryData, getSize, hasDifferences, hasDifferences, hasEntry, hasToMoveEntries

Constructor Details

DefaultIndexableRepeater

public DefaultIndexableRepeater(RepositoryData repositoryData,
 RepeaterDefinition definition,
 IndexableDataHolder parent,
 IndexableDataHolder root)

Creates a default indexable repeater

Parameters:

repositoryData - the repository data of the repeater

definition - the definition of the repeater

parent - the parent of the created repeater

root - the root IndexableDataHolder

Method Details

getEntries

public List<? extends IndexableRepeaterEntry> getEntries()

Description copied from interface: Repeater

Retrieves the repeater entries, sorted by position

Specified by:

getEntries in interface IndexableRepeater

Specified by:

getEntries in interface Repeater

Overrides:

getEntries in class DefaultRepeater

Returns:

the repeater entries

getEntry

public 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 IndexableRepeater

Specified by:

getEntry in interface Repeater

Overrides:

getEntry in class DefaultRepeater

Parameters:

position - the position of the entry to retrieve

Returns:

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

createRepeaterEntryInstance

protected IndexableRepeaterEntry createRepeaterEntryInstance(RepositoryData entryRepositoryData)

Description copied from class: DefaultRepeater

Creates an instance of RepeaterEntry to use

Overrides:

createRepeaterEntryInstance in class DefaultRepeater

Parameters:

entryRepositoryData - the repository data of the entry to create

Returns:

the created instance of RepeaterEntry

indexData

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

Description copied from interface: IndexableRepeater

Indexes all data and properties of this Repeater

Specified by:

indexData in interface IndexableRepeater

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

getParentDataHolder

public IndexableDataHolder getParentDataHolder()

Description copied from interface: Repeater

Retrieves the parent of the current Repeater

Specified by:

getParentDataHolder in interface IndexableRepeater

Specified by:

getParentDataHolder in interface Repeater

Overrides:

getParentDataHolder in class DefaultRepeater

Returns:

the parent of the current Repeater

getRootDataHolder

public IndexableDataHolder getRootDataHolder()

Description copied from interface: Repeater

Retrieves the root DataHolder of the current repeater

Specified by:

getRootDataHolder in interface IndexableRepeater

Specified by:

getRootDataHolder in interface Repeater

Overrides:

getRootDataHolder in class DefaultRepeater

Returns:

the root DataHolder