Package org.opencms.search

Class CmsSearchIndexUpdateData

java.lang.Object

org.opencms.search.CmsSearchIndexUpdateData

public class CmsSearchIndexUpdateData
extends Object

A collection of resources for the incremental update of a search index.

Since:

6.0.1

Constructor Summary

Constructors

Constructor	Description
CmsSearchIndexUpdateData(CmsSearchIndexSource source, I_CmsIndexer indexer)	Creates a new instance of an update collection.

Method Summary

Modifier and Type	Method	Description
void	addResourceToDelete(CmsPublishedResource resource)	Adds the given resource to the resources that must be deleted from the search index.
void	addResourceToUpdate(CmsPublishedResource resource)	Adds the given resource to the resources that must be updated in the search index.
I_CmsIndexer	getIndexer()	Returns the indexer of this update collection.
List<CmsPublishedResource>	getResourcesToDelete()	Returns the list of CmsPublishedResource instances that must be deleted.
List<CmsPublishedResource>	getResourcesToUpdate()	Returns the list of CmsPublishedResource instances that must be updated.
CmsSearchIndexSource	getSource()	Returns the search index source of this update collection.
boolean	hasResourcesToDelete()	Returns true if this collections contains resources to delete.
boolean	hasResourceToUpdate()	Returns true if this collections contains resources to update.
boolean	isEmpty()	Returns true if this collections contains no resources to update or delete.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSearchIndexUpdateData

public CmsSearchIndexUpdateData(CmsSearchIndexSource source,
 I_CmsIndexer indexer)

Creates a new instance of an update collection.

Parameters:

source - the search index source of this update collection

indexer - the indexer of this update collection

Method Details

addResourceToDelete

public void addResourceToDelete(CmsPublishedResource resource)

Adds the given resource to the resources that must be deleted from the search index.

Parameters:

resource - the resource to add

addResourceToUpdate

public void addResourceToUpdate(CmsPublishedResource resource)

Adds the given resource to the resources that must be updated in the search index.

Parameters:

resource - the resource to add

getIndexer

public I_CmsIndexer getIndexer()

Returns the indexer of this update collection.

Returns:

the indexer of this update collection

getResourcesToDelete

public List<CmsPublishedResource> getResourcesToDelete()

Returns the list of CmsPublishedResource instances that must be deleted.

Returns:

the list of CmsPublishedResource instances that must be deleted

getResourcesToUpdate

public List<CmsPublishedResource> getResourcesToUpdate()

Returns the list of CmsPublishedResource instances that must be updated.

Returns:

the list of CmsPublishedResource instances that must be updated

getSource

public CmsSearchIndexSource getSource()

Returns the search index source of this update collection.

Returns:

the search index source of this update collection

hasResourcesToDelete

public boolean hasResourcesToDelete()

Returns true if this collections contains resources to delete.

Returns:

true if this collections contains resources to delete

hasResourceToUpdate

public boolean hasResourceToUpdate()

Returns true if this collections contains resources to update.

Returns:

true if this collections contains resources to update

isEmpty

public boolean isEmpty()

Returns true if this collections contains no resources to update or delete.

Returns:

true if this collections contains no resources to update or delete