Package lumis.doui.search

Class SearchSource

java.lang.Object

java.util.Observable

lumis.doui.source.Source<F>

lumis.doui.source.TabularSource<ITabularSourceField>

lumis.doui.search.SearchSource

All Implemented Interfaces:

java.util.Comparator<ISourceData>

public class SearchSource
extends TabularSource<ITabularSourceField>

Source implementation for Search Results.

Since:

4.0.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchSource.SearchScope

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CATEGORIZATION_FACET_PROPERTY_ENABLE_SEARCH
static java.lang.String	FIELD_BOOST_CUSTOM_PROPERTY_NAME
static java.lang.String	SERVICE_FACET_PROPERTY_ENABLE_SEARCH
static java.lang.String	SERVICE_INSTANCE_FACET_PROPERTY_ENABLE_SEARCH
static java.lang.String	SERVICE_INSTANCE_PROPERTY_DISABLE_SEARCH
static java.lang.String	TAG_FACET_PROPERTY_ENABLE_SEARCH

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

Method Summary

Modifier and Type	Method	Description
protected TabularData	convertDataToDefinedDataTypes(TabularData originalData)	Converts the given data to another data with the values that should be used according to this source's fields definitions.
protected java.lang.String	getDefaultProviderClass()	Returns data provider class for the source.
java.lang.String	getSearcherEngineId()	Returns the searcher engine for this source
SearchSource.SearchScope	getSearcherScope()
protected boolean	isIncludePublicationUrlExistFilter()	Returns whether a filter must be included to search only for the publications with URL when loading the data for this source.

Methods inherited from class lumis.doui.source.TabularSource

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

Methods inherited from class lumis.doui.source.Source

addData, cloneData, createCustomSourceField, createDefaultCompositeFilterInstance, createDefaultFilterInstance, createRenderDataChangedEvent, createSourceFilter, deleteDataByItemIds, deleteDataByItemIds, doAddData, doCloneData, doDeleteDataByItemIds, doUpdateData, getAddInterfaceId, getAdministrationInterfaceId, getBigDataPersister, getDataForCloning, getDataProvider, getDefinitionNode, getDetailsInterfaceId, getDistinct, getDouiContext, getEditInterfaceId, getField, getFields, getFilter, getFiltersNode, getId, getIntroductionField, getIntroductionImageField, getIsCloneDataSupportedDefaultValue, getKeywordsField, getLoad, getMetaDataSourceId, getParameterClass, getParameterValue, getPrimaryNameField, getPublishStartDateField, getReadData, getSourceContainer, getSourceContext, getTransaction, getUpdateDataItemId, isAdministrationInterface, isDataCloningSupported, isDetails, isRenderDataChangedNotificationEnabled, load, postAddFieldData, postDeleteFieldData, postProcessSource, postUpdateFieldData, preAddFieldData, preDeleteFieldData, preUpdateFieldData, readData, 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

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

Field Detail

SERVICE_INSTANCE_PROPERTY_DISABLE_SEARCH

public static final java.lang.String SERVICE_INSTANCE_PROPERTY_DISABLE_SEARCH

See Also:

Constant Field Values

CATEGORIZATION_FACET_PROPERTY_ENABLE_SEARCH

public static final java.lang.String CATEGORIZATION_FACET_PROPERTY_ENABLE_SEARCH

TAG_FACET_PROPERTY_ENABLE_SEARCH

public static final java.lang.String TAG_FACET_PROPERTY_ENABLE_SEARCH

SERVICE_FACET_PROPERTY_ENABLE_SEARCH

public static final java.lang.String SERVICE_FACET_PROPERTY_ENABLE_SEARCH

SERVICE_INSTANCE_FACET_PROPERTY_ENABLE_SEARCH

public static final java.lang.String SERVICE_INSTANCE_FACET_PROPERTY_ENABLE_SEARCH

FIELD_BOOST_CUSTOM_PROPERTY_NAME

public static final java.lang.String FIELD_BOOST_CUSTOM_PROPERTY_NAME

Constructor Detail

SearchSource

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

Throws:

PortalException

Method Detail

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 TabularSource<ITabularSourceField>

Returns:

Throws:

PortalException

getSearcherEngineId

public java.lang.String getSearcherEngineId()
                                     throws PortalException

Description copied from class: TabularSource

Returns the searcher engine for this source

Overrides:

getSearcherEngineId in class TabularSource<ITabularSourceField>

Returns:

Throws:

PortalException

getSearcherScope

public SearchSource.SearchScope getSearcherScope()
                                          throws PortalException

Throws:

PortalException

isIncludePublicationUrlExistFilter

protected boolean isIncludePublicationUrlExistFilter()

Returns whether a filter must be included to search only for the publications with URL when loading the data for this source.

Returns:

true if a filter must be included to search only for the publications with URL, false otherwise.

Since:

17.1.0

convertDataToDefinedDataTypes

protected TabularData convertDataToDefinedDataTypes(TabularData originalData)
                                             throws PortalException

Description copied from class: TabularSource

Converts the given data to another data with the values that should be used according to this source's fields definitions.

Overrides:

convertDataToDefinedDataTypes in class TabularSource<ITabularSourceField>

Parameters:

originalData - the data to be converted.

Returns:

the converted data.

Throws:

PortalException