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:

Comparator<ISourceData>

@StableMinor(version="7.1",
             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: 16038 $ $Date: 2013-11-21 21:32:20 -0200 (Thu, 21 Nov 2013) $

Field Summary

Fields inherited from class lumis.doui.source.TabularSource

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
ContentTableSource(Node sourceDefinitionNode, ISourceContext sourceContext) Creates a content table source.

Method Summary

Methods

Modifier and Type	Method and Description
protected ITableSourceFilter	createDefaultFilterInstance() Creates and returns a source filter instance to be used as default to filter nodes.
protected ITableSourceField	createSourceField(Node fieldNode) Factory method for creating a source field instance that corresponds to the field node given.
protected String	getDefaultProviderClass() Returns data provider class for the source.
protected String	getDefaultSourceSearchContentFillerClassName() Returns the default source search content search filler class name.
MetaDataSourceField	getField(MetaDataSourceField.Type type) Returns the filed based on the metadata type passed in.
Collection<String>	getHyperlinkDefaultParameters() Returns the default parameters that should be used when creating a hyperlink url from this source.
String	getReindexerTabularDataProcessorClassName() Returns the class name of the reindexer for this source
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.
void	reindex(boolean localServerOnly) Deprecated.

Methods inherited from class lumis.doui.table.TableSource

createDefaultCompositeFilterInstance, createSourceFilter, getFilter, getTableName, readData, readData

Methods inherited from class lumis.doui.source.TabularSource

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

Methods inherited from class lumis.doui.source.Source

createCustomSourceField, getAddInterfaceId, getAdministrationInterfaceId, getDataProvider, getDefinitionNode, getDetailsInterfaceId, getDistinct, getDouiContext, getEditInterfaceId, getField, getFields, getFiltersNode, getId, getIntroductionField, getKeywordsField, getLoad, getMetaDataSourceId, getParameterClass, getParameterValue, getPrimaryNameField, getReadData, getSourceContainer, getSourceContext, getTransaction, isDetails, load, postProcessSource, setLoad, setParameterValue, setParameterValue, setReadData, 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

Constructor Detail

ContentTableSource

public ContentTableSource(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 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(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 Collection<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

protected String getDefaultSourceSearchContentFillerClassName()

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:

getReindexerTabularDataProcessorClassName

public String getReindexerTabularDataProcessorClassName()

Description copied from class: TabularSource

Returns the class name of the reindexer for this source

Overrides:

getReindexerTabularDataProcessorClassName in class TabularSource<ITableSourceField>

Returns:

reindex

@Deprecated
public void reindex(boolean localServerOnly)
             throws PortalException

Deprecated.

Description copied from class: TabularSource

For internal use only.

Overrides:

reindex in class TabularSource<ITableSourceField>

Throws:

PortalException

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.