lumis.search
Class Indexer

java.lang.Object
  lumis.search.Processor
      lumis.search.Indexer

Direct Known Subclasses:

LuceneIndexer

@StableMinor(version="5.5",
             sinceVersion="4.0")
public abstract class Indexer
extends Processor

Stores searcheable data in a search engine.

Since:

4.0.4

Field Summary

Fields inherited from class lumis.search.Processor

definitionNode, searchEngineId

Constructor Summary

Indexer(Node definitionNode)
Constructs an Indexer object, configured by the given definition node.

Method Summary

abstract void	addSearchContent(SearchContent searchContent) Adds a content to the index.
void	mergeSearchContent(SearchContent searchContent) Deprecated. Since 4.2.2 this method is no longer supported since most search engines do not offer such operation. Uses of this method must be adapted to use other methods of this interface. This method now throws UnsupportedOperationException and is being kept only for binary compatibility. It will be removed in a future version.
abstract void	removeSearchContent(Collection<SearchContent> searchContents) Removes a content collection from the index, using each content's identifier field as selection criteria.
abstract void	removeSearchContent(SearchContent searchContent) Removes a content from the index, using content's identifier field as selection criteria.
abstract void	removeSearchContent(SearchContent searchContent, String selectionFieldName) Removes a content from the index, using a field of a content as selection criteria.

Methods inherited from class lumis.search.Processor

getConfigNode, getConfigNodes

Methods inherited from class java.lang.Object

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

Constructor Detail

Indexer

public Indexer(Node definitionNode)
        throws PortalException

Constructs an Indexer object, configured by the given definition node.

Parameters:

definitionNode - indexer definition node.

Throws:

PortalException

Since:

4.0.4

Method Detail

addSearchContent

public abstract void addSearchContent(SearchContent searchContent)
                               throws PortalException

Adds a content to the index.

Parameters:

searchContent - the content to be added.

Throws:

PortalException

Since:

4.0.4

mergeSearchContent

@Deprecated
public void mergeSearchContent(SearchContent searchContent)
                        throws PortalException

Deprecated. Since 4.2.2 this method is no longer supported since most search engines do not offer such operation. Uses of this method must be adapted to use other methods of this interface. This method now throws UnsupportedOperationException and is being kept only for binary compatibility. It will be removed in a future version.

Updates a content in the index. The update will be done in one of the two following ways:

• If the existing SearchContent was added as updatable, it will be merged with the provided searchContent. Note that, is this case, the provided searchContent can contain only the fields that have to be updated.
• If the existing SearchContent was added as not updatable, it will be replaced by the provided searchContent.

Parameters:

searchContent - the content to be updated.

Throws:

PortalException

Since:

4.0.8

removeSearchContent

public abstract void removeSearchContent(SearchContent searchContent)
                                  throws PortalException

Removes a content from the index, using content's identifier field as selection criteria.

Parameters:

searchContent - the content to be removed.

Throws:

PortalException

Since:

4.0.4

removeSearchContent

public abstract void removeSearchContent(SearchContent searchContent,
                                         String selectionFieldName)
                                  throws PortalException

Removes a content from the index, using a field of a content as selection criteria.

Parameters:

searchContent - the content to be removed.

selectionFieldName - field to be used as selection criteria

Throws:

PortalException

Since:

4.0.4

removeSearchContent

public abstract void removeSearchContent(Collection<SearchContent> searchContents)
                                  throws PortalException

Removes a content collection from the index, using each content's identifier field as selection criteria.

Parameters:

searchContents - the contents to be removed.

Throws:

PortalException

Since:

4.0.4