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

Class DefaultModelAwareRepeater

java.lang.Object

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

All Implemented Interfaces:

IndexableRepeater, ModelAwareRepeater, Repeater

Direct Known Subclasses:

DefaultModifiableModelAwareRepeater

public class DefaultModelAwareRepeater
extends Object
implements IndexableRepeater

Class for model aware repeaters

Field Summary

Fields

Modifier and Type	Field	Description
protected RepeaterDefinition	_definition	Definition of this repeater
protected IndexableDataHolder	_parent	Parent of the current Repeater
protected RepositoryData	_repositoryData	Repository data to use to store entries in the repository
protected IndexableDataHolder	_root	Root DataHolder

Constructor Summary

Constructors

Constructor	Description
DefaultModelAwareRepeater(RepositoryData repositoryData, RepeaterDefinition definition, IndexableDataHolder parent, IndexableDataHolder root)	Creates a model aware repeater

Method Summary

Modifier and Type	Method	Description
protected Collection<ModelItem>	_getDifferencesInAppendMode(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Get the collection of model items where there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is APPEND
protected Collection<ModelItem>	_getDifferencesInReplaceAllMode(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Get the collection of model items where there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is REPLACE_ALL
protected Collection<ModelItem>	_getDifferencesInReplaceMode(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Get the collection of model items where there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is REPLACE
protected boolean	_hasDifferencesInAppendMode(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Check if there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is APPEND
protected boolean	_hasDifferencesInReplaceAllMode(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Check if there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is REPLACE_ALL
protected boolean	_hasDifferencesInReplaceMode(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Check if there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is REPLACE
void	commentsToSAX(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor)	Generates SAX events for the comments of the data in the given view in the current DataHolder
void	copyTo(ModifiableRepeater repeater, DataContext context)	Copies the current Repeater to the given ModifiableRepeater.
Map<String,Object>	dataToJSON(String dataPath, DataContext context)	Convert the data at the given path into a JSON object
Map<String,Object>	dataToJSON(DataContext context)	Convert into a JSON object the data in the model of the current Repeater
Map<String,Object>	dataToJSON(ViewItemAccessor viewItemAccessor, DataContext context)	Convert into a JSON object the data in the given view of the current Repeater
Map<String,Object>	dataToJSONForEdition(ViewItemAccessor viewItemAccessor, DataContext context)	Convert into a JSON object the data in the given view in edition mode of the current Repeater
void	dataToSAX(ContentHandler contentHandler, String dataPath, DataContext context)	Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path
void	dataToSAX(ContentHandler contentHandler, DataContext context)	Generates SAX events for the data in the model of the current DataHolder
void	dataToSAX(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)	Generates SAX events for the data in the given view in the current Repeater
void	dataToSAXForEdition(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)	Generates SAX events for the data in the given view in edition mode in the current Repeater
Collection<ModelItem>	getDifferences(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Get the collection of model items where there are differences between the given values and the repeater's entries
List<? extends IndexableRepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
IndexableRepeaterEntry	getEntry(int position)	Retrieves the repeater entry at the given position.
RepeaterDefinition	getModel()	Retrieves the repeater's model
IndexableDataHolder	getParentDataHolder()	Retrieves the parent of the current Repeater
RepositoryData	getRepositoryData()	Retrieves the repository data used by this Repeater
IndexableDataHolder	getRootDataHolder()	Retrieves the root DataHolder of the current repeater
int	getSize()	Retrieves the size of the repeater
boolean	hasDifferences(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Check if there are differences between the given values and the repeater's entries
boolean	hasEntry(int position)	Determines if the repeater has an entry at the given position.
boolean	hasToMoveEntries(Map<Integer,Integer> positionsMapping, int targetSize)	Check if has to be moved according to the given position mapping.
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 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.ModelAwareRepeater

dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDifferences, hasDifferences

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

copyTo, dataToJSON, dataToSAX

Field Details

_definition

protected RepeaterDefinition _definition

Definition of this repeater

_parent

protected IndexableDataHolder _parent

Parent of the current Repeater

_root

protected IndexableDataHolder _root

Root DataHolder

_repositoryData

protected RepositoryData _repositoryData

Repository data to use to store entries in the repository

Constructor Details

DefaultModelAwareRepeater

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

Creates a model aware 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 DataHolder

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 ModelAwareRepeater

Specified by:

getEntries in interface Repeater

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

getSize

public int getSize()

Description copied from interface: Repeater

Retrieves the size of the repeater

Specified by:

getSize in interface Repeater

Returns:

the size of the repeater

hasEntry

public boolean hasEntry(int position)

Description copied from interface: Repeater

Determines if the repeater has an 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:

hasEntry in interface Repeater

Parameters:

position - the position

Returns:

true if the repeater has an entry at the given position, false otherwise

getModel

public RepeaterDefinition getModel()

Retrieves the repeater's model

Specified by:

getModel in interface ModelAwareRepeater

Returns:

the repeater's model

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 String dataPath,
 DataContext context)
               throws SAXException

Description copied from interface: Repeater

Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path

Specified by:

dataToSAX in interface Repeater

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 DataContext context)
               throws SAXException,
BadItemTypeException

Description copied from interface: ModelAwareRepeater

Generates SAX events for the data in the model of the current DataHolder

Specified by:

dataToSAX in interface ModelAwareRepeater

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

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

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor,
 DataContext context)
               throws SAXException,
BadItemTypeException

Description copied from interface: ModelAwareRepeater

Generates SAX events for the data in the given view in the current Repeater

Specified by:

dataToSAX in interface ModelAwareRepeater

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

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

dataToSAXForEdition

public void dataToSAXForEdition(ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor,
 DataContext context)
                         throws SAXException,
BadItemTypeException

Description copied from interface: ModelAwareRepeater

Generates SAX events for the data in the given view in edition mode in the current Repeater

Specified by:

dataToSAXForEdition in interface ModelAwareRepeater

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

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

dataToJSON

public Map<String,Object> dataToJSON(String dataPath,
 DataContext context)
                              throws IOException

Description copied from interface: Repeater

Convert the data at the given path into a JSON object

Specified by:

dataToJSON in interface Repeater

Parameters:

dataPath - the path of the data to convert

context - The context of the data to convert

Returns:

The value as JSON

Throws:

IOException - if an error occurs while reading a value using the I/O API

dataToJSON

public Map<String,Object> dataToJSON(DataContext context)
                              throws BadItemTypeException

Description copied from interface: ModelAwareRepeater

Convert into a JSON object the data in the model of the current Repeater

Specified by:

dataToJSON in interface ModelAwareRepeater

Parameters:

context - The context of the data to convert

Returns:

The data of the current DataHolder as JSON

Throws:

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

dataToJSON

public Map<String,Object> dataToJSON(ViewItemAccessor viewItemAccessor,
 DataContext context)
                              throws BadItemTypeException

Description copied from interface: ModelAwareRepeater

Convert into a JSON object the data in the given view of the current Repeater

Specified by:

dataToJSON in interface ModelAwareRepeater

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to convert

context - The context of the data to convert

Returns:

The data of the given view as JSON

Throws:

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

dataToJSONForEdition

public Map<String,Object> dataToJSONForEdition(ViewItemAccessor viewItemAccessor,
 DataContext context)
                                        throws BadItemTypeException

Description copied from interface: ModelAwareRepeater

Convert into a JSON object the data in the given view in edition mode of the current Repeater

Specified by:

dataToJSONForEdition in interface ModelAwareRepeater

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to convert

context - The context of the data to convert

Returns:

The data of the given view as JSON

Throws:

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

commentsToSAX

public void commentsToSAX(ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor)
                   throws SAXException

Generates SAX events for the comments of the data in the given view in the current DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

Throws:

SAXException - if an error occurs during the SAX events generation

copyTo

public void copyTo(ModifiableRepeater repeater,
 DataContext context)
            throws UndefinedItemPathException,
BadItemTypeException,
UnknownTypeException,
NotUniqueTypeException

Description copied from interface: Repeater

Copies the current Repeater to the given ModifiableRepeater.

Specified by:

copyTo in interface Repeater

Parameters:

repeater - The destination repeater. Can not be null.

context - The context of the data to copy

Throws:

UndefinedItemPathException - if one of the copied data is not defined by the model of the destination ModifiableModelAwareRepeater

BadItemTypeException - if the type defined by the model of the destination ModifiableModelAwareRepeater doesn't match the copied value

UnknownTypeException

NotUniqueTypeException

indexData

public 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

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

hasDifferences

public boolean hasDifferences(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                       throws UndefinedItemPathException,
BadItemTypeException

Description copied from interface: ModelAwareRepeater

Check if there are differences between the given values and the repeater's entries

Specified by:

hasDifferences in interface ModelAwareRepeater

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

true if there are differences, false otherwise

Throws:

UndefinedItemPathException - if an entry's key refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the entry's key doesn't match the corresponding value

_hasDifferencesInAppendMode

protected boolean _hasDifferencesInAppendMode(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                                       throws UndefinedItemPathException,
BadItemTypeException

Check if there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is APPEND

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

true if there are differences, false otherwise

Throws:

UndefinedItemPathException - if an entry's key refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the entry's key doesn't match the corresponding value

_hasDifferencesInReplaceMode

protected boolean _hasDifferencesInReplaceMode(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                                        throws UndefinedItemPathException,
BadItemTypeException

Check if there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is REPLACE

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

true if there are differences, false otherwise

Throws:

UndefinedItemPathException - if an entry's key refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the entry's key doesn't match the corresponding value

_hasDifferencesInReplaceAllMode

protected boolean _hasDifferencesInReplaceAllMode(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                                           throws UndefinedItemPathException,
BadItemTypeException

Check if there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is REPLACE_ALL

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

true if there are differences, false otherwise

Throws:

UndefinedItemPathException - if an entry's key refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the entry's key doesn't match the corresponding value

getDifferences

public Collection<ModelItem> getDifferences(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                                     throws UndefinedItemPathException,
BadItemTypeException

Description copied from interface: ModelAwareRepeater

Get the collection of model items where there are differences between the given values and the repeater's entries

Specified by:

getDifferences in interface ModelAwareRepeater

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

a collection of model items with differences

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

_getDifferencesInAppendMode

protected Collection<ModelItem> _getDifferencesInAppendMode(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                                                     throws UndefinedItemPathException,
BadItemTypeException

Get the collection of model items where there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is APPEND

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

a collection of model items with differences

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

_getDifferencesInReplaceMode

protected Collection<ModelItem> _getDifferencesInReplaceMode(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                                                      throws UndefinedItemPathException,
BadItemTypeException

Get the collection of model items where there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is REPLACE

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

a collection of model items with differences

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

_getDifferencesInReplaceAllMode

protected Collection<ModelItem> _getDifferencesInReplaceAllMode(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                                                         throws UndefinedItemPathException,
BadItemTypeException

Get the collection of model items where there are differences between the given values and the repeater's entries if SynchronizableRepeater.getMode() is REPLACE_ALL

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

a collection of model items with differences

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

hasToMoveEntries

public boolean hasToMoveEntries(Map<Integer,Integer> positionsMapping,
 int targetSize)

Description copied from interface: Repeater

Check if has to be moved according to the given position mapping. The given position mapping's key is the previous position and the value is the new one The existent entries with no corresponding entry in the position mapping should be removed the given size is taken into account to create new empty entries if needed

Specified by:

hasToMoveEntries in interface Repeater

Parameters:

positionsMapping - the position mapping

targetSize - the target size of the repeater

Returns:

true if some entries have moved, false otherwise

getRepositoryData

public RepositoryData getRepositoryData()

Description copied from interface: Repeater

Retrieves the repository data used by this Repeater

Specified by:

getRepositoryData in interface Repeater

Returns:

the repository data used by this Repeater

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 ModelAwareRepeater

Specified by:

getParentDataHolder in interface Repeater

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 ModelAwareRepeater

Specified by:

getRootDataHolder in interface Repeater

Returns:

the root DataHolder