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

Class IndexableDataHolderHelper

java.lang.Object

org.ametys.cms.data.holder.impl.IndexableDataHolderHelper

All Implemented Interfaces:

Disposable, Component, Serviceable

public final class IndexableDataHolderHelper
extends Object
implements Component, Serviceable, Disposable

Helper for implementations of indexable data holder

Constructor Summary

Constructors

Constructor	Description
IndexableDataHolderHelper()

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	dataToJSON(ModelAwareDataHolder dataHolder, ViewItemAccessor viewItemAccessor, DataContext context, boolean isEdition)	Convert the data in the given view of the given DataHolder
static Map<String,Object>	dataToMap(ModelAwareDataHolder dataHolder, ViewItemAccessor viewItemAccessor, DataContext context)	Returns all data of the given DataHolder as a typed-values Map.
static void	dataToSAX(ModelAwareDataHolder dataHolder, ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context, boolean isEdition)	Generates SAX events for the data in the given view in the given DataHolder
void	dispose()
static Map<String,Object>	externalizableValuesAsJson(ModelAwareDataHolder dataHolder, String dataName, DataContext context)	Convert the externalizable data with the given name
static ModelAwareDataAwareAmetysObject	getAmetysObjectFromContext(DataContext context)	Retrieves the ModelAwareDataAwareAmetysObject from the given DataContext
static SystemPropertyExtensionPoint	getContentSystemPropertyExtensionPoint()	Retrieves the SystemPropertyExtensionPoint for content system properties
static boolean	hasValue(ModelAwareDataHolder dataHolder, String dataPath, DataContext context)	Check if there is a value to render at the given path
static List<org.apache.solr.common.SolrInputDocument>	indexData(IndexableDataHolder dataHolder, ViewItemAccessor viewItemAccessor, org.apache.solr.common.SolrInputDocument document, org.apache.solr.common.SolrInputDocument rootDocument, String solrFieldPrefix, IndexableDataContext context)	Indexes data of the given IndexableDataHolder
static boolean	renderValue(ModelAwareDataHolder dataHolder, String dataPath, DataContext context, boolean isEdition)	Check if the value at the given path should be rendered
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Constructor Details

IndexableDataHolderHelper

public IndexableDataHolderHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

indexData

public static List<org.apache.solr.common.SolrInputDocument> indexData(IndexableDataHolder dataHolder,
 ViewItemAccessor viewItemAccessor,
 org.apache.solr.common.SolrInputDocument document,
 org.apache.solr.common.SolrInputDocument rootDocument,
 String solrFieldPrefix,
 IndexableDataContext context)
                                                                throws BadItemTypeException

Indexes data of the given IndexableDataHolder

Parameters:

dataHolder - the IndexableDataHolder to index

viewItemAccessor - the view item accessor to explore

document - the solr document representing this IndexableDataHolder

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

dataToSAX

public static void dataToSAX(ModelAwareDataHolder dataHolder,
 ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor,
 DataContext context,
 boolean isEdition)
                      throws SAXException,
BadItemTypeException,
UndefinedItemPathException

Generates SAX events for the data in the given view in the given DataHolder

Parameters:

dataHolder - the ModelAwareDataHolder to SAX

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

isEdition - true if SAX events are generated in edition mode, false otherwise

Throws:

SAXException - if an error occurs during the SAX events generation

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

UndefinedItemPathException - if an item in the view is not part of the model

dataToJSON

public static Map<String,Object> dataToJSON(ModelAwareDataHolder dataHolder,
 ViewItemAccessor viewItemAccessor,
 DataContext context,
 boolean isEdition)
                                     throws BadItemTypeException,
UndefinedItemPathException

Convert the data in the given view of the given DataHolder

Parameters:

dataHolder - the ModelAwareDataHolder containing the data to convert

viewItemAccessor - the ViewItemAccessor referencing the items to convert

context - The context of the data to convert

isEdition - true to convert in edition mode, false otherwise

Returns:

The data of the given view as JSON

Throws:

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

UndefinedItemPathException - if an item in the view is not part of the model

externalizableValuesAsJson

public static Map<String,Object> externalizableValuesAsJson(ModelAwareDataHolder dataHolder,
 String dataName,
 DataContext context)

Convert the externalizable data with the given name

Parameters:

dataHolder - the ModelAwareDataHolder containing the data to convert

dataName - the name of the data to convert

context - The context of the data to convert

Returns:

The data with the given name as JSON

dataToMap

public static Map<String,Object> dataToMap(ModelAwareDataHolder dataHolder,
 ViewItemAccessor viewItemAccessor,
 DataContext context)

Returns all data of the given DataHolder as a typed-values Map.

Parameters:

dataHolder - the DataHolder to export

viewItemAccessor - the ViewItemAccessor referencing the items to include in the resulting Map

context - The context of the data

Returns:

a Map containing all data.

getAmetysObjectFromContext

public static ModelAwareDataAwareAmetysObject getAmetysObjectFromContext(DataContext context)

Retrieves the ModelAwareDataAwareAmetysObject from the given DataContext

Parameters:

context - the context containing the ametys object

Returns:

the ametys object, or null if there is no object id in the context

renderValue

public static boolean renderValue(ModelAwareDataHolder dataHolder,
 String dataPath,
 DataContext context,
 boolean isEdition)

Check if the value at the given path should be rendered

Parameters:

dataHolder - the data holder containing the data to check

dataPath - the path of the data to check

context - the data context

isEdition - true if values are rendered in edition mode, false otherwise

Returns:

true if the value has to be rendered, false otherwise

hasValue

public static boolean hasValue(ModelAwareDataHolder dataHolder,
 String dataPath,
 DataContext context)

Check if there is a value to render at the given path

Parameters:

dataHolder - the data holder containing the data to check

dataPath - the path of the data to check

context - the data context

Returns:

true if there is a value to render, false otherwise

getContentSystemPropertyExtensionPoint

public static SystemPropertyExtensionPoint getContentSystemPropertyExtensionPoint()

Retrieves the SystemPropertyExtensionPoint for content system properties

Returns:

the SystemPropertyExtensionPoint for content system properties