com.atlassian.confluence.search.lucene.tasks
Class BaseContentIndexTask

java.lang.Object
  com.atlassian.confluence.search.lucene.tasks.BaseContentIndexTask

All Implemented Interfaces:

ContentIndexTask, IndexTask

Direct Known Subclasses:

AddDocumentIndexTask, DeleteDocumentIndexTask, UnIndexSpaceIndexTask, UpdateDocumentIndexTask

public abstract class BaseContentIndexTask
extends java.lang.Object
implements ContentIndexTask

A base implementation of a ContentIndexTask, that maintains a handle to the searchable target.

Field Summary

protected com.atlassian.bonnie.AnyTypeObjectDao	anyTypeObjectDao Required resource.
protected com.atlassian.bonnie.search.DocumentBuilder	documentBuilder Required resource.
protected com.atlassian.bonnie.Handle	handle The handle that identifies the searchable instance being indexed.
protected java.lang.String	spaceKey The spacekey (if any) of the instance being indexed
protected com.atlassian.bonnie.Searchable	target The searchable subject of this index task.

Constructor Summary

protected	BaseContentIndexTask()
	BaseContentIndexTask(com.atlassian.bonnie.Searchable target) Create a new index task.
protected	BaseContentIndexTask(java.lang.String handle)

Method Summary

protected com.atlassian.bonnie.Handle	createHandle(com.atlassian.bonnie.Searchable target)
protected com.atlassian.bonnie.Handle	createHandle(java.lang.String handle) The default create handle implementation creates a handle that can be used to retrieve the searchable target from the persistent store via the
boolean	equals(java.lang.Object other) Two content index tasks are considered equal if they are of the same type and contain the same handle.
com.atlassian.bonnie.Handle	getHandle()
com.atlassian.bonnie.Searchable	getTarget()
int	hashCode()
void	setAnyTypeObjectDao(com.atlassian.bonnie.AnyTypeObjectDao anyTypeObjectDao) Required resource for converting handles into searchable instances so that the content to be indexed can be retrieved.
void	setDocumentBuilder(com.atlassian.bonnie.search.DocumentBuilder documentBuilder) Required resource for converting searchable instances into documents to be indexed.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.search.lucene.IndexTask

getDescription

Field Detail

documentBuilder

protected com.atlassian.bonnie.search.DocumentBuilder documentBuilder

Required resource. The document builder is used to create a lucene document from a searchable instance.

anyTypeObjectDao

protected com.atlassian.bonnie.AnyTypeObjectDao anyTypeObjectDao

Required resource. The any type object dao is used to resolve hibernate handles into objects.

handle

protected com.atlassian.bonnie.Handle handle

The handle that identifies the searchable instance being indexed.

spaceKey

protected java.lang.String spaceKey

The spacekey (if any) of the instance being indexed

target

protected transient com.atlassian.bonnie.Searchable target

The searchable subject of this index task.

Constructor Detail

BaseContentIndexTask

protected BaseContentIndexTask()

BaseContentIndexTask

public BaseContentIndexTask(com.atlassian.bonnie.Searchable target)

Create a new index task.

Parameters:

target -

Throws:

java.lang.IllegalArgumentException - if the searchable target is not indexible, as defined by the isIndexable call.

BaseContentIndexTask

protected BaseContentIndexTask(java.lang.String handle)
                        throws java.text.ParseException

Throws:

java.text.ParseException

Method Detail

createHandle

protected com.atlassian.bonnie.Handle createHandle(java.lang.String handle)
                                            throws java.text.ParseException

The default create handle implementation creates a handle that can be used to retrieve the searchable target from the persistent store via the

AnyTypeObjectDao.findByHandle(handle);

Parameters:

handle -

Returns:

Throws:

java.text.ParseException

getTarget

public com.atlassian.bonnie.Searchable getTarget()

getHandle

public com.atlassian.bonnie.Handle getHandle()

Specified by:

getHandle in interface ContentIndexTask

equals

public boolean equals(java.lang.Object other)

Two content index tasks are considered equal if they are of the same type and contain the same handle. Equal tasks will have the same effect on the search index.

Overrides:

equals in class java.lang.Object

Parameters:

other -

Returns:

true if this object and the other are considered equal.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

createHandle

protected com.atlassian.bonnie.Handle createHandle(com.atlassian.bonnie.Searchable target)

setDocumentBuilder

public void setDocumentBuilder(com.atlassian.bonnie.search.DocumentBuilder documentBuilder)

Required resource for converting searchable instances into documents to be indexed.

Parameters:

documentBuilder -

setAnyTypeObjectDao

public void setAnyTypeObjectDao(com.atlassian.bonnie.AnyTypeObjectDao anyTypeObjectDao)

Required resource for converting handles into searchable instances so that the content to be indexed can be retrieved.

Parameters:

anyTypeObjectDao -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object