Package lumis.service.hierarchicalcontent

Class HierarchicalContentSource

java.lang.Object

java.util.Observable

lumis.doui.source.Source<F>

lumis.doui.source.TabularSource<ITableSourceField>

lumis.doui.table.TableSource

lumis.content.table.ContentTableSource

lumis.service.hierarchicalcontent.HierarchicalContentSource

All Implemented Interfaces:

java.util.Comparator<ISourceData>, IContentTableSourcePreviewBehavior

public class HierarchicalContentSource
extends ContentTableSource
implements IContentTableSourcePreviewBehavior

Hierarchical content source.

Since:

16.1.0

Nested Class Summary

Nested classes/interfaces inherited from class lumis.content.table.ContentTableSource

ContentTableSource.LockStrategy

Field Summary

Fields inherited from class lumis.content.table.ContentTableSource

ASSIGNED_TO_PARAMETER_NAME, ASSIGNED_TO_PARAMETER_VALUE_NULL, TRANSITION_PARAMETER_NAME

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
HierarchicalContentSource(org.w3c.dom.Node sourceDefinitionNode, ISourceContext sourceContext)

Method Summary

Modifier and Type	Method	Description
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 IContentTableSourceUpdateDataResult	doUpdateData(IParameters data)	Updates the data in the persistence.
java.util.Set<java.lang.String>	getPreviewInterfaceInstanceIds(java.lang.String itemId)	Returns the identifiers of the service interface instances that may be used for previewing the specified item.
IContentTableSourceUpdateDataResult	updateData(java.lang.Object data, ContentTableSource.LockStrategy lockStrategy)	Updates a data in the persistence this source represents.

Methods inherited from class lumis.content.table.ContentTableSource

addData, createDefaultFilterInstance, createQueryBuilder, createSourceField, deleteDataByItemIds, deleteDataByItemIds, deleteInactiveVersionsByItemIds, deleteVersionDataByItemIds, doAddData, doCloneData, doDeleteDataByItemIds, getBigDataPersister, getCloneDataTitleSuffix, getDefaultBigDataPersister, getDefaultProviderClass, getDefaultSourceSearchContentFillerClassName, getField, getHyperlinkDefaultParameters, getUpdateDataItemId, getWorkflowConfig, isAdministrationInterface, isPublishAllAccessibleContents, isWorkflowSupported, postDeleteDataByItemIds, preDeleteDataByItemIds, scheduleContentAddedEvent, scheduleIndexData, updateData

Methods inherited from class lumis.doui.table.TableSource

createDefaultCompositeFilterInstance, createSourceFilter, deleteRelatedData, getFilter, getIsCloneDataSupportedDefaultValue, 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

cloneData, createCustomSourceField, deleteDataByItemIds, getAddInterfaceId, getAdministrationInterfaceId, getDataForCloning, getDataProvider, getDefinitionNode, getDetailsInterfaceId, getDistinct, getDouiContext, getEditInterfaceId, getField, getFields, getFiltersNode, getId, getIntroductionField, getIntroductionImageField, getKeywordsField, getLoad, getMetaDataSourceId, getParameterClass, getParameterValue, getPrimaryNameField, getPublishStartDateField, getReadData, getSourceContainer, getSourceContext, getTransaction, isDataCloningSupported, 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

Constructor Detail

HierarchicalContentSource

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

Throws:

PortalException

Method Detail

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 ContentTableSource

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

updateData

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

Description copied from class: ContentTableSource

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 ContentTableSource.doUpdateData(IParameters).
3. Sends the render data changed notification.

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

Overrides:

updateData in class ContentTableSource

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

doUpdateData

protected IContentTableSourceUpdateDataResult doUpdateData(IParameters data)
                                                    throws PortalException

Description copied from class: ContentTableSource

Updates the data in the persistence.

This method is called by ContentTableSource.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 ContentTableSource

Parameters:

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

Returns:

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

Throws:

PortalException

getPreviewInterfaceInstanceIds

public java.util.Set<java.lang.String> getPreviewInterfaceInstanceIds(java.lang.String itemId)
                                                               throws PortalException

Description copied from interface: IContentTableSourcePreviewBehavior

Returns the identifiers of the service interface instances that may be used for previewing the specified item. The preview functionality will analyze the returned identifiers and may discard some of them due to other configurations or constraints.

Specified by:

getPreviewInterfaceInstanceIds in interface IContentTableSourcePreviewBehavior

Parameters:

itemId - the item identifier.

Returns:

a set with the service interface instance identifiers, or an empty set if none may be used.

Throws:

PortalException