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

Class DefaultModifiableIndexableRepeater

java.lang.Object

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

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

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

All Implemented Interfaces:

IndexableRepeater, ModifiableIndexableRepeater, ModifiableRepeater, Repeater

public class DefaultModifiableIndexableRepeater
extends DefaultModifiableRepeater
implements ModifiableIndexableRepeater

Class for modifiable indexable repeaters

Field Summary

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

_lockableAmetysObject, _modifiableParent, _modifiableRepositoryData, _modifiableRoot

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

_definition, _parent, _repositoryData, _root

Constructor Summary

Constructors

Constructor	Description
DefaultModifiableIndexableRepeater(ModifiableRepositoryData repositoryData, RepeaterDefinition definition, Optional<LockableAmetysObject> lockableAmetysObject, ModifiableIndexableDataHolder parent, ModifiableIndexableDataHolder root)	Creates a default modifiable indexable repeater

Method Summary

Modifier and Type	Method	Description
ModifiableIndexableRepeaterEntry	addEntry()	Creates a Repeater entry at the last position.
ModifiableIndexableRepeaterEntry	addEntry(int position)	Creates a Repeater entry at the given position.
protected ModifiableIndexableRepeaterEntry	createRepeaterEntryInstance(RepositoryData entryRepositoryData)	Creates an instance of RepeaterEntry to use
List<? extends ModifiableIndexableRepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
ModifiableIndexableRepeaterEntry	getEntry(int position)	Retrieves the repeater entry at the given position.
ModifiableIndexableDataHolder	getParentDataHolder()	Retrieves the parent of the current Repeater
ModifiableIndexableDataHolder	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.DefaultModifiableRepeater

getRepositoryData, moveEntries, removeEntries, removeEntry, synchronizeValues

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, 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.ModifiableRepeater

getRepositoryData, moveEntries, removeEntries, removeEntry, synchronizeValues, synchronizeValues

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, getSize, hasDifferences, hasDifferences, hasEntry, hasToMoveEntries

Constructor Details

DefaultModifiableIndexableRepeater

public DefaultModifiableIndexableRepeater(ModifiableRepositoryData repositoryData,
 RepeaterDefinition definition,
 Optional<LockableAmetysObject> lockableAmetysObject,
 ModifiableIndexableDataHolder parent,
 ModifiableIndexableDataHolder root)

Creates a default modifiable indexable repeater

Parameters:

repositoryData - the repository data of the repeater

definition - the definition of the repeater

lockableAmetysObject - the ametys object that can be locked on data modification

parent - the parent of the created repeater

root - the root ModifiableIndexableDataHolder

Method Details

getEntries

public List<? extends ModifiableIndexableRepeaterEntry> getEntries()

Description copied from interface: Repeater

Retrieves the repeater entries, sorted by position

Specified by:

getEntries in interface IndexableRepeater

Specified by:

getEntries in interface ModifiableIndexableRepeater

Specified by:

getEntries in interface ModifiableRepeater

Specified by:

getEntries in interface Repeater

Overrides:

getEntries in class DefaultModifiableRepeater

Returns:

the repeater entries

getEntry

public ModifiableIndexableRepeaterEntry 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 ModifiableIndexableRepeater

Specified by:

getEntry in interface ModifiableRepeater

Specified by:

getEntry in interface Repeater

Overrides:

getEntry in class DefaultModifiableRepeater

Parameters:

position - the position of the entry to retrieve

Returns:

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

addEntry

public ModifiableIndexableRepeaterEntry addEntry()

Description copied from interface: ModifiableRepeater

Creates a Repeater entry at the last position.

Specified by:

addEntry in interface ModifiableIndexableRepeater

Specified by:

addEntry in interface ModifiableRepeater

Overrides:

addEntry in class DefaultModifiableRepeater

Returns:

the created entry

addEntry

public ModifiableIndexableRepeaterEntry addEntry(int position)
                                          throws IllegalArgumentException

Description copied from interface: ModifiableRepeater

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

Specified by:

addEntry in interface ModifiableIndexableRepeater

Specified by:

addEntry in interface ModifiableRepeater

Overrides:

addEntry in class DefaultModifiableRepeater

Parameters:

position - The position of the new entry

Returns:

the created entry

Throws:

IllegalArgumentException - if the position is not between the negative and positive repeater size

createRepeaterEntryInstance

protected ModifiableIndexableRepeaterEntry createRepeaterEntryInstance(RepositoryData entryRepositoryData)

Description copied from class: DefaultRepeater

Creates an instance of RepeaterEntry to use

Overrides:

createRepeaterEntryInstance in class DefaultModifiableRepeater

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 ModifiableIndexableDataHolder getParentDataHolder()

Description copied from interface: Repeater

Retrieves the parent of the current Repeater

Specified by:

getParentDataHolder in interface IndexableRepeater

Specified by:

getParentDataHolder in interface ModifiableIndexableRepeater

Specified by:

getParentDataHolder in interface ModifiableRepeater

Specified by:

getParentDataHolder in interface Repeater

Overrides:

getParentDataHolder in class DefaultModifiableRepeater

Returns:

the parent of the current Repeater

getRootDataHolder

public ModifiableIndexableDataHolder 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 ModifiableIndexableRepeater

Specified by:

getRootDataHolder in interface ModifiableRepeater

Specified by:

getRootDataHolder in interface Repeater

Overrides:

getRootDataHolder in class DefaultModifiableRepeater

Returns:

the root DataHolder