lumis.doui.table

Class TableSource

java.lang.Object

java.util.Observable

lumis.doui.source.Source<F>

lumis.doui.source.TabularSource<ITableSourceField>

lumis.doui.table.TableSource

All Implemented Interfaces:

Comparator<ISourceData>

Direct Known Subclasses:

AutomationFlowSource, ContentTableSource, CorsRulesSource, JourneySource, JourneyStageSource, MonitorRequestRuleSource, ProcessPurposeSource, ProjectSource, QuestionSource, SynonymTableSource, UserAttributesSource, UserSegmentationSource

@StableMinor(version="12.4",
             sinceVersion="4.0")
public class TableSource
extends TabularSource<ITableSourceField>

A source that is based on a database table.

Since:

4.0.0

Version:

$Revision: 23905 $ $Date: 2020-06-16 15:29:26 +0000 (Tue, 16 Jun 2020) $

Field Summary

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 and Description
TableSource(Node sourceDefinitionNode, ISourceContext sourceContext) Creates a tabular source.

Method Summary

Modifier and Type	Method and Description
protected ITableSourceFilter	createDefaultCompositeFilterInstance() Creates and returns a source filter instance to be used as default to filters nodes.
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 ITableSourceField	createSourceField(Node fieldNode) Factory method for creating a source field instance that corresponds to the field node given.
ITableSourceFilter	createSourceFilter(Node filterNode) Creates a source filter for the given filter definition node.
protected void	deleteRelatedData(Collection<String> itemIds) Deletes all data related to the given itemIds.
protected ISourceAddDataResult	doAddData(IParameters data) Adds the data to the persistence.
protected void	doDeleteDataByItemIds(Collection<String> itemIds) Deletes the data in the persistence.
protected ISourceUpdateDataResult	doUpdateData(IParameters data) Updates the data in the persistence.
protected <S extends Source<?>> ISourceBigDataPersister<S>	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 String	getDefaultProviderClass() Returns data provider class for the source.
ITableSourceFilter	getFilter() Returns the filter for this source.
String	getTableName() Returns the table name for this source.
List<ISourceData>	readData(Collection<String> itemIds) Returns the data corresponding to the given itemIds.
TabularData	readData(String[] primaryKeyValues, ITransaction transaction) Deprecated. Since 10.4.0 replaced by Source.readData(String...) and #readData(Iterable) for Source persistence API standardization. This method is no longer called and kept only for backwards compatibility.
ISourceData	readData(String primaryKeyValue, ITransaction transaction) Deprecated. Since 10.4.0 replaced by Source.readData(String...) and #readData(Iterable) for Source persistence API standardization. This method is no longer called and kept only for backwards compatibility.

Methods inherited from class lumis.doui.source.TabularSource

applyPostLoadFilters, applyPostLoadPagination, compare, compareField, convertDataToDefinedDataTypes, convertDataToDefinedDataTypes, evaluateMaxRows, getData, getDefaultSourceSearchContentFillerClassName, getDouiHyperlinkItemParameterField, getFieldClass, getFieldId, getFieldIds, getFieldName, getFieldsDefinitionNode, getHyperlinkDefaultParameters, 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

addData, createCustomSourceField, createRenderDataChangedEvent, deleteDataByItemIds, deleteDataByItemIds, getAddInterfaceId, getAdministrationInterfaceId, getBigDataPersister, getDataProvider, getDefinitionNode, getDetailsInterfaceId, getDistinct, getDouiContext, getEditInterfaceId, getField, getFields, getFiltersNode, getId, getIntroductionField, getIntroductionImageField, getKeywordsField, getLoad, getMetaDataSourceId, getParameterClass, getParameterValue, getPrimaryNameField, getPublishStartDateField, getReadData, getSourceContainer, getSourceContext, getTransaction, getUpdateDataItemId, isAdministrationInterface, isDetails, isRenderDataChangedNotificationEnabled, load, postAddFieldData, postDeleteFieldData, postProcessSource, postUpdateFieldData, preAddFieldData, preDeleteFieldData, preUpdateFieldData, readData, scheduleIndexData, scheduleIndexData, sendPostAddDataNotification, sendPostDeleteDataNotification, sendPostUpdateDataNotification, sendPreAddDataNotification, sendPreDeleteDataNotification, sendPreUpdateDataNotification, sendRenderDataChangedNotification, sendRenderDataChangedNotification, setLoad, setParameterValue, setParameterValue, setReadData, setRenderDataChangedNotificationEnabled, updateData, 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

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

TableSource

public TableSource(Node sourceDefinitionNode,
                   ISourceContext sourceContext)
            throws PortalException

Creates a tabular source.

Parameters:

sourceDefinitionNode - the source definition node.

sourceContext - the source context.

Throws:

PortalException

Since:

4.0.4

Method Detail

getTableName

public String getTableName()

Returns the table name for this source.

Returns:

the table name for this source.

Since:

4.0.5

createSourceFilter

public ITableSourceFilter createSourceFilter(Node filterNode)
                                      throws PortalException

Description copied from class: Source

Creates a source filter for the given filter definition node. The node may be a filters or filter node.

Overrides:

createSourceFilter in class Source<ITableSourceField>

Parameters:

filterNode - the filter definition node.

Returns:

the source filter.

Throws:

PortalException

createDefaultCompositeFilterInstance

protected ITableSourceFilter createDefaultCompositeFilterInstance()

Description copied from class: Source

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

Overrides:

createDefaultCompositeFilterInstance in class Source<ITableSourceField>

Returns:

the created instance.

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

Returns:

the created instance.

getFilter

public ITableSourceFilter getFilter()

Description copied from class: Source

Returns the filter for this source. The filter must be initialized with the appropriated parameters before each use.

Overrides:

getFilter in class Source<ITableSourceField>

Returns:

the filter or null if this source has no filter.

createSourceField

protected ITableSourceField createSourceField(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 TabularSource<ITableSourceField>

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)

readData

@Deprecated
public ISourceData readData(String primaryKeyValue,
                                        ITransaction transaction)
                                 throws PortalException

Deprecated. Since 10.4.0 replaced by Source.readData(String...) and #readData(Iterable) for Source persistence API standardization. This method is no longer called and kept only for backwards compatibility.

Reads the data with the given primary key value, and returns it.

Parameters:

primaryKeyValue - the primary key value of the desired data.

transaction - the transaction for persistence access.

Returns:

the data with the given primary key value.

Throws:

PortalException

NullPointerException - if primaryKeyValue is null.

readData

@Deprecated
public TabularData readData(String[] primaryKeyValues,
                                        ITransaction transaction)
                                 throws PortalException

Deprecated. Since 10.4.0 replaced by Source.readData(String...) and #readData(Iterable) for Source persistence API standardization. This method is no longer called and kept only for backwards compatibility.

Reads the data with the given primary key values, and returns it.

Parameters:

primaryKeyValues - the primary key values of the desired data.

transaction - the transaction for persistence access.

Returns:

the data with the given primary key values.

Throws:

PortalException

{@link - NullPointerException} if primaryKeyValues contain a null value.

getDefaultProviderClass

protected 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 TabularSource<ITableSourceField>

Returns:

Throws:

PortalException

getDefaultBigDataPersister

protected <S extends Source<?>> ISourceBigDataPersister<S> 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 TabularSource<ITableSourceField>

Returns:

the default ISourceBigDataPersister implementation.

readData

public List<ISourceData> readData(Collection<String> itemIds)
                           throws PortalException

Description copied from class: Source

Returns the data corresponding to the given itemIds.

The implementation of this method in Source throws an UnsupportedOperationException. This method should be overridden by source implementations that provides this functionality.

Overrides:

readData in class Source<ITableSourceField>

Parameters:

itemIds - the item identifiers of the data to be returned.

Returns:

a list of ISourceData objects that corresponds to the given itemIds. If no data is found, an empty list is returned.

Throws:

PortalException

createQueryBuilder

protected QueryBuilder createQueryBuilder(IParameters parameters)
                                   throws PortalException

Creates the query builder used by this source.

Parameters:

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

Returns:

the query builder.

Throws:

PortalException

Since:

10.4.0

doAddData

protected ISourceAddDataResult doAddData(IParameters data)
                                  throws PortalException

Description copied from class: Source

Adds the data to the persistence.

This method is called by Source.addData(Object) and is to be overridden by sources that supports add operation and uses the default addData implementation.

The implementation of this method in Source throws UnsupportedOperationException.

Overrides:

doAddData in class Source<ITableSourceField>

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

doUpdateData

protected ISourceUpdateDataResult doUpdateData(IParameters data)
                                        throws PortalException

Description copied from class: Source

Updates the data in the persistence.

This method is called by Source.updateData(Object) and is to be overridden by sources that supports update operation and uses the default updateData implementation.

The implementation of this method in Source throws UnsupportedOperationException.

Overrides:

doUpdateData in class Source<ITableSourceField>

Parameters:

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

Returns:

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

Throws:

PortalException

doDeleteDataByItemIds

protected void doDeleteDataByItemIds(Collection<String> itemIds)
                              throws PortalException

Description copied from class: Source

Deletes the data in the persistence.

This method is called by Source.deleteDataByItemIds(Collection) and is to be overridden by sources that supports delete operation and uses the default deleteData implementation.

The implementation of this method in Source throws UnsupportedOperationException.

Overrides:

doDeleteDataByItemIds in class Source<ITableSourceField>

Parameters:

itemIds - the item identifiers of data to be deleted.

Throws:

PortalException

deleteRelatedData

protected void deleteRelatedData(Collection<String> itemIds)
                          throws PortalException

Deletes all data related to the given itemIds.

This method looks up all the relations of the data being deleted. If any of them have the attribute cascadeOnDelete set to true, the related source data is deleted.

Parameters:

itemIds - the item identifiers whose related data is to be deleted.

Throws:

PortalException

Since:

10.4.0