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

Class DataHolderHelper

java.lang.Object

org.ametys.plugins.repository.data.holder.impl.DataHolderHelper

public final class DataHolderHelper
extends Object

Helper for implementations of data holder

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DataHolderHelper()

Method Summary

Modifier and Type	Method and Description
static void	copyDataHolder(DataHolder source, ModifiableDataHolder destination) Copies the source DataHolder to the given ModifiableDataHolder destination.
static void	dataHolderToSAX(DataHolder dataHolder, ContentHandler contentHandler, Locale locale) Generates SAX events for the given DataHolder
static void	dataHolderValueToSAX(DataHolder dataHolder, ContentHandler contentHandler, String dataPath, String tagName, Locale locale) Generates SAX events for the data at the given data path in the given DataHolder Do not generate any event if there is no values at the given path
static String	getDefinitionPathFromDataPath(String dataPath) Retrieves the given dataPath as a definition path (without the repeaterEntry positions)
static ModelItem	getModelItem(String path, Collection<? extends ModelItemContainer> itemContainers) Retrieves the model item at the given relative path
static RepeaterEntry	getRepeaterEntry(DataHolder dataHolder, String repeaterName, int entryPosition) Retrieves the repeater entry represented by the given path segment
static Pair<String,Integer>	getRepeaterNameAndEntryPosition(String pathSegment) Retrieves the pair of repeater name and entry position of the given path segment Return null if the given path does not represent a repeater entry
static boolean	hasModelItem(String path, Collection<? extends ModelItemContainer> itemContainers) Checks if there is a model item at the given relative path
static boolean	isRepeaterEntryPath(String path) Test if the path is a repeater entry path (for example entries[1])

Methods inherited from class java.lang.Object

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

Constructor Detail

DataHolderHelper

private DataHolderHelper()

Method Detail

hasModelItem

public static boolean hasModelItem(String path,
                                   Collection<? extends ModelItemContainer> itemContainers)

Checks if there is a model item at the given relative path

Parameters:

path - path of the model item. This path is relative to the given containers. No matter if it is a definition or data path (with repeater entry positions)

itemContainers - model item containers where to search if there is a model item

Returns:

true if there is model item at this path, false otherwise

getModelItem

public static ModelItem getModelItem(String path,
                                     Collection<? extends ModelItemContainer> itemContainers)
                              throws IllegalArgumentException,
                                     UndefinedItemPathException

Retrieves the model item at the given relative path

Parameters:

path - path of the model item to retrieve. This path is relative to the given containers. No matter if it is a definition or data path (with repeater entry positions)

itemContainers - model item containers where to search the model item

Returns:

the model item

Throws:

IllegalArgumentException - if the given path is null or empty

UndefinedItemPathException - if there is no item defined at the given path in given item containers

getDefinitionPathFromDataPath

public static String getDefinitionPathFromDataPath(String dataPath)

Retrieves the given dataPath as a definition path (without the repeaterEntry positions)

Parameters:

dataPath - the data path

Returns:

the definition path

getRepeaterEntry

public static RepeaterEntry getRepeaterEntry(DataHolder dataHolder,
                                             String repeaterName,
                                             int entryPosition)
                                      throws BadItemTypeException

Retrieves the repeater entry represented by the given path segment

Parameters:

dataHolder - data holder that contains the repeater entry. The data holder must be the direct parent of the repeater

repeaterName - the name of the repeater

entryPosition - the position of the entry

Returns:

the repeater entry

Throws:

BadItemTypeException - if the value stored in the repository for the given repeater name is not a repeater

isRepeaterEntryPath

public static boolean isRepeaterEntryPath(String path)

Test if the path is a repeater entry path (for example entries[1])

Parameters:

path - the path representing the repeater entry

Returns:

true if the pathSegment is a repeater entry path

getRepeaterNameAndEntryPosition

public static Pair<String,Integer> getRepeaterNameAndEntryPosition(String pathSegment)

Retrieves the pair of repeater name and entry position of the given path segment Return null if the given path does not represent a repeater entry

Parameters:

pathSegment - the path segment representing the repeater entry

Returns:

the pair of repeater name and entry position

copyDataHolder

public static void copyDataHolder(DataHolder source,
                                  ModifiableDataHolder destination)

Copies the source DataHolder to the given ModifiableDataHolder destination.

Parameters:

source - the source DataHolder

destination - the ModifiableDataHolder destination

dataHolderToSAX

public static void dataHolderToSAX(DataHolder dataHolder,
                                   ContentHandler contentHandler,
                                   Locale locale)
                            throws SAXException

Generates SAX events for the given DataHolder

Parameters:

dataHolder - the DataHolder to SAX

contentHandler - the ContentHandler that will receive the SAX events

locale - The locale to use for localized data, such as MultilingualString. Can be null to generate SAX events for all existing Locales.

Throws:

SAXException - if an error occurs during the SAX events generation

dataHolderValueToSAX

public static void dataHolderValueToSAX(DataHolder dataHolder,
                                        ContentHandler contentHandler,
                                        String dataPath,
                                        String tagName,
                                        Locale locale)
                                 throws SAXException

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

Parameters:

dataHolder - the DataHolder containing the value to SAX

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

tagName - the tag name of the SAX event to generate. If null the name of the data is used

locale - The locale to use for localized data, such as MultilingualString. Can be null to generate SAX events for all existing Locales.

Throws:

SAXException - if an error occurs during the SAX events generation