Package org.opencms.search

Class CmsVfsIndexer

java.lang.Object

org.opencms.search.CmsVfsIndexer

All Implemented Interfaces:

I_CmsIndexer

Direct Known Subclasses:

CmsDependencyIndexer

public class CmsVfsIndexer
extends Object
implements I_CmsIndexer

An indexer indexing CmsResource based content from the OpenCms VFS.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsObject	m_cms	The OpenCms user context to use when reading resources from the VFS during indexing.
protected I_CmsSearchIndex	m_index	The index.
protected I_CmsReport	m_report	The report.

Constructor Summary

Constructors

Constructor	Description
CmsVfsIndexer()

Method Summary

Modifier and Type	Method	Description
protected void	addResourceToUpdateData(CmsPublishedResource pubRes, CmsSearchIndexUpdateData updateData)	Adds a given published resource to the provided search index update data.
protected void	deleteResource(I_CmsIndexWriter indexWriter, CmsPublishedResource resource)	Deletes a resource with the given index writer.
void	deleteResources(I_CmsIndexWriter indexWriter, List<CmsPublishedResource> resourcesToDelete)	Incremental index update - delete the index entry for all resources in the given list.
CmsObject	getCms()	Returns the OpenCms user context used by this indexer.
I_CmsSearchIndex	getIndex()	Returns the OpenCms search index updated by this indexer.
I_CmsReport	getReport()	Returns the report used by this indexer.
CmsSearchIndexUpdateData	getUpdateData(CmsSearchIndexSource source, List<CmsPublishedResource> publishedResources)	Calculates the data for an incremental search index update.
boolean	isLocaleDependenciesEnable()	The default indexer is not able to resolve locale dependencies between documents.
protected boolean	isResourceInTimeWindow(CmsPublishedResource resource)	Checks if the published resource is inside the time window set with release and expiration date.
I_CmsIndexer	newInstance(CmsObject cms, I_CmsReport report, I_CmsSearchIndex index)	Creates and initializes a new instance of this indexer implementation.
void	rebuildIndex(I_CmsIndexWriter writer, CmsIndexingThreadManager threadManager, CmsSearchIndexSource source)	Rebuilds the index for the given configured index source.
protected void	updateResource(I_CmsIndexWriter indexWriter, String rootPath, I_CmsSearchDocument doc)	Updates a resource with the given index writer and the new document provided.
protected void	updateResource(I_CmsIndexWriter writer, CmsIndexingThreadManager threadManager, CmsResource resource)	Updates (writes) a single resource in the index.
void	updateResources(I_CmsIndexWriter writer, CmsIndexingThreadManager threadManager, List<CmsPublishedResource> resourcesToUpdate)	Incremental index update - create a new index entry for all resources in the given list.

Methods inherited from class java.lang.Object

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

Field Details

m_cms

protected CmsObject m_cms

The OpenCms user context to use when reading resources from the VFS during indexing.

m_index

protected I_CmsSearchIndex m_index

The index.

m_report

protected I_CmsReport m_report

The report.

Constructor Details

CmsVfsIndexer

public CmsVfsIndexer()

Method Details

deleteResources

public void deleteResources(I_CmsIndexWriter indexWriter,
 List<CmsPublishedResource> resourcesToDelete)

Description copied from interface: I_CmsIndexer

Incremental index update - delete the index entry for all resources in the given list.

Specified by:

deleteResources in interface I_CmsIndexer

Parameters:

indexWriter - the writer to the index to delete the entries from

resourcesToDelete - a list of CmsPublishedResource instances that must be deleted

See Also:

• I_CmsIndexer.deleteResources(org.opencms.search.I_CmsIndexWriter, java.util.List)

getCms

public CmsObject getCms()

Returns the OpenCms user context used by this indexer.

Returns:

the OpenCms user context used by this indexer

getIndex

public I_CmsSearchIndex getIndex()

Returns the OpenCms search index updated by this indexer.

Returns:

the OpenCms search index updated by this indexer

getReport

public I_CmsReport getReport()

Returns the report used by this indexer.

Returns:

the report used by this indexer

getUpdateData

public CmsSearchIndexUpdateData getUpdateData(CmsSearchIndexSource source,
 List<CmsPublishedResource> publishedResources)

Description copied from interface: I_CmsIndexer

Calculates the data for an incremental search index update.

Specified by:

getUpdateData in interface I_CmsIndexer

Parameters:

source - the search index source to update

publishedResources - a list of CmsPublishedResource objects that are to be updated

Returns:

a container with the information about the resources to delete and / or update

See Also:

• I_CmsIndexer.getUpdateData(org.opencms.search.CmsSearchIndexSource, java.util.List)

isLocaleDependenciesEnable

public boolean isLocaleDependenciesEnable()

The default indexer is not able to resolve locale dependencies between documents.

Specified by:

isLocaleDependenciesEnable in interface I_CmsIndexer

Returns:

true if this VFS indexer is able to resolve locale dependencies between documents

See Also:

• I_CmsIndexer.isLocaleDependenciesEnable()

newInstance

public I_CmsIndexer newInstance(CmsObject cms,
 I_CmsReport report,
 I_CmsSearchIndex index)

Description copied from interface: I_CmsIndexer

Creates and initializes a new instance of this indexer implementation.

Specified by:

newInstance in interface I_CmsIndexer

Parameters:

cms - the OpenCms user context to use when reading resources from the VFS during indexing

report - the report to write the indexing output to

index - the search index to update

Returns:

a new instance of this indexer implementation

See Also:

• I_CmsIndexer.newInstance(org.opencms.file.CmsObject, org.opencms.report.I_CmsReport, org.opencms.search.I_CmsSearchIndex)

rebuildIndex

public void rebuildIndex(I_CmsIndexWriter writer,
 CmsIndexingThreadManager threadManager,
 CmsSearchIndexSource source)

Description copied from interface: I_CmsIndexer

Rebuilds the index for the given configured index source.

This is used when the index is fully rebuild, not for updating only some parts of an existing index.

Specified by:

rebuildIndex in interface I_CmsIndexer

Parameters:

writer - the index writer to write the update to

threadManager - the thread manager to use when extracting the document text

source - the search index source to update

See Also:

• I_CmsIndexer.rebuildIndex(org.opencms.search.I_CmsIndexWriter, org.opencms.search.CmsIndexingThreadManager, org.opencms.search.CmsSearchIndexSource)

updateResources

public void updateResources(I_CmsIndexWriter writer,
 CmsIndexingThreadManager threadManager,
 List<CmsPublishedResource> resourcesToUpdate)

Description copied from interface: I_CmsIndexer

Incremental index update - create a new index entry for all resources in the given list.

Specified by:

updateResources in interface I_CmsIndexer

Parameters:

writer - the index writer to write the update to

threadManager - the thread manager to use when extracting the document text

resourcesToUpdate - a list of CmsPublishedResource instances that must be updated

See Also:

• I_CmsIndexer.updateResources(org.opencms.search.I_CmsIndexWriter, org.opencms.search.CmsIndexingThreadManager, java.util.List)

addResourceToUpdateData

protected void addResourceToUpdateData(CmsPublishedResource pubRes,
 CmsSearchIndexUpdateData updateData)

Adds a given published resource to the provided search index update data.

This method decides if the resource has to be included in the "update" or "delete" list.

Parameters:

pubRes - the published resource to add

updateData - the search index update data to add the resource to

deleteResource

protected void deleteResource(I_CmsIndexWriter indexWriter,
 CmsPublishedResource resource)

Deletes a resource with the given index writer.

Parameters:

indexWriter - the index writer to resource the resource with

resource - the root path of the resource to delete

isResourceInTimeWindow

protected boolean isResourceInTimeWindow(CmsPublishedResource resource)

Checks if the published resource is inside the time window set with release and expiration date.

Parameters:

resource - the published resource to check

Returns:

true if the published resource is inside the time window, otherwise false

updateResource

protected void updateResource(I_CmsIndexWriter writer,
 CmsIndexingThreadManager threadManager,
 CmsResource resource)

Updates (writes) a single resource in the index.

Parameters:

writer - the index writer to use

threadManager - the thread manager to use when extracting the document text

resource - the resource to update

updateResource

protected void updateResource(I_CmsIndexWriter indexWriter,
 String rootPath,
 I_CmsSearchDocument doc)

Updates a resource with the given index writer and the new document provided.

Parameters:

indexWriter - the index writer to update the resource with

rootPath - the root path of the resource to update

doc - the new document for the resource