Package lumis.content.table

Class ContentTableSource

java.lang.Object

java.util.Observable

lumis.doui.source.Source<F>

lumis.doui.source.TabularSource<ITableSourceField>

lumis.doui.table.TableSource

lumis.content.table.ContentTableSource

All Implemented Interfaces:

java.util.Comparator<ISourceData>

Direct Known Subclasses:

ChatRoomSource, ColRequestSource, DashboardSource, ExperimentSource, NavigationSource, PrivacyTermSource, ReportSource, TagManagerSource

@StableMinor(version="15.0",
             sinceVersion="4.0")
public class ContentTableSource
extends TableSource

This source implementation adds content functionalities to the TableSource it extends.

Since:

4.0.0

Version:

$Revision: 25304 $ $Date: 2022-10-22 22:51:05 -0300 (Sat, 22 Oct 2022) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContentTableSource.LockStrategy	Strategy on how to handle ContentLocale's locks during content operation.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ASSIGNED_TO_PARAMETER_NAME	The parameter that defines the value for workflow's assignedTo.
static java.lang.String	ASSIGNED_TO_PARAMETER_VALUE_NULL	Value to indicate the assigned to is to be set to null.
static java.lang.String	TRANSITION_PARAMETER_NAME	The parameter that defines the workflow's transition to be executed.

Fields inherited from class lumis.doui.source.TabularSource

positionSourceField, primaryKeySourceField, searchableSourceFields, tabularData

Fields inherited from class lumis.doui.source.Source

addInterfaceId, administrationInterfaceId, connectionId, detailsInterfaceId, editInterfaceId, fields, fieldsMap, id, introductionSourceField, keywordsSourceField, load, metaDataSourceId, parameters, primaryNameSourceField, readData, SOURCE_READ_DATA_ALWAYS, SOURCE_READ_DATA_NEVER, SOURCE_READ_DATA_ON_DEMAND, sourceContext, sourceDefinitionNode

Constructor Summary

Constructors

Constructor	Description
ContentTableSource(org.w3c.dom.Node sourceDefinitionNode, ISourceContext sourceContext)	Creates a content table source.

Method Summary

Modifier and Type	Method	Description
IContentTableSourceAddDataResult	addData(java.lang.Object data)	Adds a data in the persistence this source represents.
protected ITableSourceFilter	createDefaultFilterInstance()	Creates and returns a source filter instance to be used as default to filter nodes.
protected QueryBuilder	createQueryBuilder(IParameters parameters)	Creates the query builder used by this source.
protected java.util.Collection<IPortalEvent>	createRenderDataChangedEvent(PortalEventOperationType operationType, java.util.Collection<java.lang.String> itemIds)	Returns the render data changed event to be sent by Source.sendRenderDataChangedNotification(PortalEventOperationType, Collection).
protected ITableSourceField	createSourceField(org.w3c.dom.Node fieldNode)	Factory method for creating a source field instance that corresponds to the field node given.
void	deleteDataByItemIds(java.util.Collection<java.lang.String> itemIds)	Calls deleteDataByItemIds(Collection, LockStrategy) using same lock strategy of current operation if this delete is cascaded from another content, or with lock strategy of ContentTableSource.LockStrategy.CHECK_AND_RELEASE_AUTOMATIC_ON_COMMIT otherwise.
void	deleteDataByItemIds(java.util.Collection<java.lang.String> itemIds, ContentTableSource.LockStrategy lockStrategy)	Deletes data from the persistence this source represents.
protected void	deleteVersionDataByItemIds(java.util.Collection<java.lang.String> itemIds)	Deletes the data related to the versions of the given item identifiers.
protected IContentTableSourceAddDataResult	doAddData(IParameters data)	Adds the data to the persistence.
protected void	doDeleteDataByItemIds(java.util.Collection<java.lang.String> itemIds)	Deletes the data in the persistence.
protected IContentTableSourceUpdateDataResult	doUpdateData(IParameters data)	Updates the data in the persistence.
IContentTableSourceBigDataPersister	getBigDataPersister()	Returns the ISourceBigDataPersister implementation to be used for this source.
protected IContentTableSourceBigDataPersister	getDefaultBigDataPersister()	Returns the default ISourceBigDataPersister implementation to be used for this source if the big data persisting is not disabled and no specific persister class is configured for this source.
protected java.lang.String	getDefaultProviderClass()	Returns data provider class for the source.
protected java.lang.String	getDefaultSourceSearchContentFillerClassName()	Deprecated. Since 8.1.0 this method is no longer used and remains only for binary compatibility, due to lumis.search being replaced by lumis.portal.bigdata.
MetaDataSourceField	getField(MetaDataSourceField.Type type)	Returns the filed based on the metadata type passed in.
java.util.Collection<java.lang.String>	getHyperlinkDefaultParameters()	Returns the default parameters that should be used when creating a hyperlink url from this source.
protected java.lang.String	getUpdateDataItemId(IParameters data)	Returns the item identifier of a data being updated, this will consider the id to the right active version.
WorkflowConfig	getWorkflowConfig()	Returns the workflow associated with this source.
protected boolean	isAdministrationInterface(IServiceInterface serviceInterface)	Returns true if the given service interface is the main administration interface for this source.
boolean	isPublishAllAccessibleContents()	Indicates if contents not published to the current service instance but accessible by the current user should also be published.
boolean	isWorkflowSupported()	Verifies if the current source supports a workflow.
protected void	postDeleteDataByItemIds(java.util.Collection<java.lang.String> itemIds)	Called after delete operation.
protected void	preDeleteDataByItemIds(java.util.Collection<java.lang.String> itemIds)	Called before delete operation.
protected void	scheduleContentAddedEvent(ContentVersion contentVersion)	Schedules a content added event for the given content to be executed once the transaction is commited.
void	scheduleIndexData(java.util.Collection<java.lang.String> itemIds)	Schedules the indexing of the data that corresponds to the specified item identifiers.
IContentTableSourceUpdateDataResult	updateData(java.lang.Object data)	Calls updateData(data, LockStrategy.CHECK_AND_RELEASE_AUTOMATIC_ON_COMMIT).
IContentTableSourceUpdateDataResult	updateData(java.lang.Object data, ContentTableSource.LockStrategy lockStrategy)	Updates a data in the persistence this source represents.

Methods inherited from class lumis.doui.table.TableSource

createDefaultCompositeFilterInstance, createSourceFilter, deleteRelatedData, getFilter, getTableName, readData, readData, readData

Methods inherited from class lumis.doui.source.TabularSource

applyPostLoadFilters, applyPostLoadPagination, compare, compareField, convertDataToDefinedDataTypes, convertDataToDefinedDataTypes, evaluateMaxRows, getData, getDouiHyperlinkItemParameterField, getFieldClass, getFieldId, getFieldIds, getFieldName, getFieldsDefinitionNode, getIndexerEngineId, getIndexerId, getMaxRows, getPositionField, getPrimaryKeyField, getReindexerTabularDataProcessorClassName, getSearchableFields, getSearcherEngineId, getSearcherId, getSortedFieldIds, getSourceSearchContentFillerClassName, getStartAt, hasField, isSearchEnabled, readFieldsIntoFieldsMap, setData, setMaxRows, setStartAt

Methods inherited from class lumis.doui.source.Source

createCustomSourceField, deleteDataByItemIds, getAddInterfaceId, getAdministrationInterfaceId, getDataProvider, getDefinitionNode, getDetailsInterfaceId, getDistinct, getDouiContext, getEditInterfaceId, getField, getFields, getFiltersNode, getId, getIntroductionField, getIntroductionImageField, getKeywordsField, getLoad, getMetaDataSourceId, getParameterClass, getParameterValue, getPrimaryNameField, getPublishStartDateField, getReadData, getSourceContainer, getSourceContext, getTransaction, isDetails, isRenderDataChangedNotificationEnabled, load, postAddFieldData, postDeleteFieldData, postProcessSource, postUpdateFieldData, preAddFieldData, preDeleteFieldData, preUpdateFieldData, readData, scheduleIndexData, sendPostAddDataNotification, sendPostDeleteDataNotification, sendPostUpdateDataNotification, sendPreAddDataNotification, sendPreDeleteDataNotification, sendPreUpdateDataNotification, sendRenderDataChangedNotification, sendRenderDataChangedNotification, setLoad, setParameterValue, setParameterValue, setReadData, setRenderDataChangedNotificationEnabled, valueChanged

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

TRANSITION_PARAMETER_NAME

public static final java.lang.String TRANSITION_PARAMETER_NAME

The parameter that defines the workflow's transition to be executed. The value, if set, is to be the identifier of the workflow transition to be executed (e.g. "authoring.approve"). The transition must exist in the current content workflow state. If the parameter is not present or is set to null, no transition is executed.

Since:

10.4.0

See Also:

Constant Field Values

ASSIGNED_TO_PARAMETER_NAME

public static final java.lang.String ASSIGNED_TO_PARAMETER_NAME

The parameter that defines the value for workflow's assignedTo. A value of ASSIGNED_TO_PARAMETER_VALUE_NULL indicates to change to null, and any other value indicates to change to that value. If the parameter is not present or is set to null, the assigned to is not to be changed.

Since:

10.4.0

See Also:

ASSIGNED_TO_PARAMETER_VALUE_NULL, Constant Field Values

ASSIGNED_TO_PARAMETER_VALUE_NULL

public static final java.lang.String ASSIGNED_TO_PARAMETER_VALUE_NULL

Value to indicate the assigned to is to be set to null.

Since:

10.4.0

See Also:

ASSIGNED_TO_PARAMETER_NAME, Constant Field Values

Constructor Detail

ContentTableSource

public ContentTableSource(org.w3c.dom.Node sourceDefinitionNode,
                          ISourceContext sourceContext)
                   throws PortalException

Creates a content table source.

Parameters:

sourceDefinitionNode - the source definition node.

sourceContext - the source context.

Throws:

PortalException

Since:

4.0.4

Method Detail

isAdministrationInterface

protected boolean isAdministrationInterface(IServiceInterface serviceInterface)

Returns true if the given service interface is the main administration interface for this source.

Overrides:

isAdministrationInterface in class Source<ITableSourceField>

Parameters:

serviceInterface - the service interface.

Returns:

true if the given service interface is the main administration interface for this source, false otherwise.

Since:

4.0.6

getDefaultProviderClass

protected java.lang.String getDefaultProviderClass()
                                            throws PortalException

Description copied from class: TabularSource

Returns data provider class for the source. Always throws an exceptions since this source does not have a default provider class.

Overrides:

getDefaultProviderClass in class TableSource

Returns:

Throws:

PortalException

getWorkflowConfig

public WorkflowConfig getWorkflowConfig()
                                 throws PortalException

Returns the workflow associated with this source.

Returns:

the workflow associated with this source, or null if this source has no workflow.

Throws:

PortalException

Since:

4.0.7

isWorkflowSupported

public boolean isWorkflowSupported()
                            throws PortalException

Verifies if the current source supports a workflow.

Returns:

true if the source supports, false otherwise.

Throws:

PortalException

Since:

4.0.8

isPublishAllAccessibleContents

public boolean isPublishAllAccessibleContents()

Indicates if contents not published to the current service instance but accessible by the current user should also be published. Affects the query generated for the source in publication interfaces.

Returns:

true if accessible contents not published to this service instance should also be published, false otherwise.

Since:

4.2.0

createSourceField

protected ITableSourceField createSourceField(org.w3c.dom.Node fieldNode)
                                       throws PortalException

Description copied from class: Source

Factory method for creating a source field instance that corresponds to the field node given. This method instantiate and returns the source field, without initializing it.

Overrides:

createSourceField in class TableSource

Parameters:

fieldNode - the field node.

Returns:

the ISourceField created, or null if no field should be created for this node.

Throws:

PortalException

See Also:

Source.createCustomSourceField(Node)

getHyperlinkDefaultParameters

public java.util.Collection<java.lang.String> getHyperlinkDefaultParameters()

Description copied from class: Source

Returns the default parameters that should be used when creating a hyperlink url from this source.

Overrides:

getHyperlinkDefaultParameters in class TabularSource<ITableSourceField>

Returns:

a collection with the default parameter names.

getField

public MetaDataSourceField getField(MetaDataSourceField.Type type)

Returns the filed based on the metadata type passed in.

Parameters:

type -

Returns:

Since:

4.0.11

getDefaultSourceSearchContentFillerClassName

@Deprecated
protected java.lang.String getDefaultSourceSearchContentFillerClassName()

Deprecated.

Since 8.1.0 this method is no longer used and remains only for binary compatibility, due to lumis.search being replaced by lumis.portal.bigdata. Consider using getDefaultBigDataPersister() instead.

Description copied from class: TabularSource

Returns the default source search content search filler class name.

The default value defined in this class is lumis.doui.search.DouiTabularSourceSearchContentFiller.

Overrides:

getDefaultSourceSearchContentFillerClassName in class TabularSource<ITableSourceField>

Returns:

createDefaultFilterInstance

protected ITableSourceFilter createDefaultFilterInstance()

Description copied from class: Source

Creates and returns a source filter instance to be used as default to filter nodes.

Overrides:

createDefaultFilterInstance in class TableSource

Returns:

the created instance.

getBigDataPersister

public IContentTableSourceBigDataPersister getBigDataPersister()

Description copied from class: Source

Returns the ISourceBigDataPersister implementation to be used for this source.

Overrides:

getBigDataPersister in class Source<ITableSourceField>

Returns:

the ISourceBigDataPersister implementation.

getDefaultBigDataPersister

protected IContentTableSourceBigDataPersister getDefaultBigDataPersister()

Description copied from class: Source

Returns the default ISourceBigDataPersister implementation to be used for this source if the big data persisting is not disabled and no specific persister class is configured for this source.

This method is called by Source.getBigDataPersister() when the default is to be used.

Overrides:

getDefaultBigDataPersister in class TableSource

Returns:

the default ISourceBigDataPersister implementation.

createQueryBuilder

protected QueryBuilder createQueryBuilder(IParameters parameters)
                                   throws PortalException

Description copied from class: TableSource

Creates the query builder used by this source.

Overrides:

createQueryBuilder in class TableSource

Parameters:

parameters - the parameters to be used by the query builder.

Returns:

the query builder.

Throws:

PortalException

scheduleIndexData

public void scheduleIndexData(java.util.Collection<java.lang.String> itemIds)
                       throws PortalException

Schedules the indexing of the data that corresponds to the specified item identifiers. Due to the non-transactional nature of big data, this method must schedule the actual indexing for after the transaction commit.

Note that differently from Source's implementation, ContentTableSource does not call this method by its standard operations that add/update/delete data, since it is expected to content JPA trigger data indexing.

Overrides:

scheduleIndexData in class Source<ITableSourceField>

Parameters:

itemIds - the item identifiers.

Throws:

PortalException

Since:

10.4.0

addData

public IContentTableSourceAddDataResult addData(java.lang.Object data)
                                         throws PortalException

Adds a data in the persistence this source represents.

The implementation of this method in Source does the following:

1. Calls doAddData(IParameters), method to be implemented by sources that supports this operation.
2. Sends the render data changed notification.
3. Calls scheduleContentAddedEvent(ContentVersion) to add a content added event in monitoring framework (in the default implementation, the event will only be added if the source context's transaction is correctly commited).

Differently from Source default implementation, for optimization reasons, ContentTableSource assumes that doAddData(IParameters) will already schedule the index of the data, so this method does not call scheduleIndexData(Collection).

Special parameters that may be set on data for ContentTableSource:

• TRANSITION_PARAMETER_NAME: optional parameter that may be set with the identifier of the workflow transition to perform during this add operation.
• ASSIGNED_TO_PARAMETER_NAME: optional parameter that may be set with the identifier of the principal to be set as workflow's assigned to.
• <language field identifier>.languageId: optional String parameter specifying the locale to set for the content being added. This parameter is for backwards compatibility, as the locale may also be set using a parameter with name equals to the language field identifier (which accepts String and Locale values). If no locale is specified in any of these parameters, the current SessionConfig's locale will be used.
• <language field identifier>.contentId: optional parameter that when set with the identifier of a Content, indicates that the ContentLocale being added is to belong to that Content.
• <language field identifier>.isDefaultLocale: optional parameter that when set to true indicates the content's default locale is to be set to the locale of the data being added.
• publish to principals field identifier: optional parameters that may be a string with comma-separated identifiers or a Collection of identifiers. Default value is everyone group.
• publish to service instances field identifier: optional parameters that may be a string with comma-separated identifiers or a Collection of identifiers. Default value is this source's service instance.

Overrides:

addData in class Source<ITableSourceField>

Parameters:

data - the acceptable types of data object depends on the source implementation. The default Source implementation expects an object compatible with IParameters.asParameters(Object).

Returns:

a result object with information about the added data.

Throws:

PortalException

Since:

10.4.0

scheduleContentAddedEvent

protected void scheduleContentAddedEvent(ContentVersion contentVersion)
                                  throws PortalException

Schedules a content added event for the given content to be executed once the transaction is commited.

Parameters:

contentVersion - the content version.

Throws:

PortalException

Since:

12.0.0

doAddData

protected IContentTableSourceAddDataResult doAddData(IParameters data)
                                              throws PortalException

Adds the data to the persistence.

This method is called by addData(Object).

ContentTableSource expects this method to automatically schedule the content indexing, if required. This is usually automatically triggered by content JPA entities.

Overrides:

doAddData in class TableSource

Parameters:

data - the data given to Source.addData(Object), converted to IParameters if necessary.

Returns:

the result object to be returned by Source.addData(Object).

Throws:

PortalException

Since:

10.4.0

updateData

public IContentTableSourceUpdateDataResult updateData(java.lang.Object data)
                                               throws PortalException

Calls updateData(data, LockStrategy.CHECK_AND_RELEASE_AUTOMATIC_ON_COMMIT).

Overrides:

updateData in class Source<ITableSourceField>

Parameters:

data - the acceptable types of data object depends on the source implementation. The default Source implementation expects an object compatible with IParameters.asParameters(Object).

Returns:

a result object with information about the updated data.

Throws:

PortalException

Since:

10.4.0

See Also:

updateData(Object, LockStrategy)

updateData

public IContentTableSourceUpdateDataResult updateData(java.lang.Object data,
                                                      ContentTableSource.LockStrategy lockStrategy)
                                               throws PortalException

Updates a data in the persistence this source represents.

The implementation of this method in ContentTableSource does the following:

1. Checks and handles the lock state of the content being updated according to the specified lockStrategy.
2. Calls doUpdateData(IParameters).
3. Sends the render data changed notification.

Accepts the same special parameters available in addData(Object).

Parameters:

data - the data to be updated. Expects an object compatible with IParameters.asParameters(Object).

lockStrategy - how content lock state is to be handled.

Returns:

a result object with information about the updated data.

Throws:

ContentLockedException - if update operation could not be executed because the content is locked by another user.

PortalException

Since:

10.4.0

getUpdateDataItemId

protected java.lang.String getUpdateDataItemId(IParameters data)

Returns the item identifier of a data being updated, this will consider the id to the right active version.

Overrides:

getUpdateDataItemId in class Source<ITableSourceField>

Parameters:

data - the data.

Returns:

the active version item identifier.

Since:

12.0.0

doUpdateData

protected IContentTableSourceUpdateDataResult doUpdateData(IParameters data)
                                                    throws PortalException

Updates the data in the persistence.

This method is called by updateData(Object, LockStrategy).

If the source has versioning, this method calls Source.preAddFieldData(SourcePreAddDataEvent). Otherwise it calls Source.preUpdateFieldData(SourcePreUpdateDataEvent).

ContentTableSource expects this method to automatically schedule the content indexing, if required. This is usually automatically triggered by content JPA entities.

Overrides:

doUpdateData in class TableSource

Parameters:

data - the data argument given to updateData(Object, LockStrategy), converted to IParameters if necessary.

Returns:

the result object to be returned by updateData(Object, LockStrategy).

Throws:

PortalException

Since:

10.4.0

createRenderDataChangedEvent

protected java.util.Collection<IPortalEvent> createRenderDataChangedEvent(PortalEventOperationType operationType,
                                                                          java.util.Collection<java.lang.String> itemIds)
                                                                   throws PortalException

Description copied from class: Source

Returns the render data changed event to be sent by Source.sendRenderDataChangedNotification(PortalEventOperationType, Collection).

Overrides:

createRenderDataChangedEvent in class Source<ITableSourceField>

Parameters:

operationType - the operation type for the notification.

itemIds - the item identifiers.

Returns:

the event to be sent, or null to nothing be sent.

Throws:

PortalException

deleteDataByItemIds

public void deleteDataByItemIds(java.util.Collection<java.lang.String> itemIds)
                         throws PortalException

Calls deleteDataByItemIds(Collection, LockStrategy) using same lock strategy of current operation if this delete is cascaded from another content, or with lock strategy of ContentTableSource.LockStrategy.CHECK_AND_RELEASE_AUTOMATIC_ON_COMMIT otherwise.

Overrides:

deleteDataByItemIds in class Source<ITableSourceField>

Parameters:

itemIds - the item identifiers of data to be deleted.

Throws:

PortalException

Since:

10.4.0

See Also:

deleteDataByItemIds(Collection, LockStrategy)

deleteDataByItemIds

public void deleteDataByItemIds(java.util.Collection<java.lang.String> itemIds,
                                ContentTableSource.LockStrategy lockStrategy)
                         throws PortalException

Deletes data from the persistence this source represents.

The implementation of this method in ContentTableSource does the following:

1. Checks and handles the lock state of the content being deleted according to the specified lockStrategy.
2. Sends the render data changed notification.
3. Calls #preDeleteFieldData(ISourcePreDeleteDataEvent) on a source instance created from the source definition at service level.
4. Calls doDeleteDataByItemIds(Collection).

Parameters:

itemIds - the item identifiers of data to be deleted.

lockStrategy - how content lock state is to be handled.

Throws:

PortalException

Since:

10.4.0

doDeleteDataByItemIds

protected void doDeleteDataByItemIds(java.util.Collection<java.lang.String> itemIds)
                              throws PortalException

Deletes the data in the persistence.

This method is called by deleteDataByItemIds(Collection, LockStrategy).

The implementation of this method does the following:

1. Calls preDeleteDataByItemIds(Collection).
2. Calls deleteVersionDataByItemIds(Collection).
3. Deletes content metadata.
4. Calls postDeleteDataByItemIds(Collection).

ContentTableSource expects this method to automatically schedule the delete of the related indexed data. This is usually automatically triggered by content JPA entities.

Overrides:

doDeleteDataByItemIds in class TableSource

Parameters:

itemIds - the item identifiers of data to be deleted.

Throws:

PortalException

Since:

10.4.0

See Also:

deleteDataByItemIds(Collection, LockStrategy)

preDeleteDataByItemIds

protected void preDeleteDataByItemIds(java.util.Collection<java.lang.String> itemIds)
                               throws PortalException

Called before delete operation.

It is called by doDeleteDataByItemIds(Collection) and by special operations that deletes versions without deleting the whole ContentLocale.

This method calls Source.sendPreDeleteDataNotification(SourcePreDeleteDataEvent) and Source.preDeleteFieldData(SourcePreDeleteDataEvent).

Parameters:

itemIds - the item identifiers being deleted.

Throws:

PortalException

Since:

10.4.0

postDeleteDataByItemIds

protected void postDeleteDataByItemIds(java.util.Collection<java.lang.String> itemIds)
                                throws PortalException

Called after delete operation.

It is called by doDeleteDataByItemIds(Collection) and by special operations that deletes versions without deleting the whole ContentLocale.

This method calls Source.sendPostDeleteDataNotification(SourcePostDeleteDataEvent) and Source.postDeleteFieldData(SourcePostDeleteDataEvent).

Parameters:

itemIds - the item identifiers being deleted.

Throws:

PortalException

Since:

10.4.0

deleteVersionDataByItemIds

protected void deleteVersionDataByItemIds(java.util.Collection<java.lang.String> itemIds)
                                   throws PortalException

Deletes the data related to the versions of the given item identifiers. This method does not delete any content metadata.

It is called by doDeleteDataByItemIds(Collection) and by special operations that deletes versions without deleting the whole ContentLocale.

Parameters:

itemIds - the item identifiers.

Throws:

PortalException

Since:

10.4.0