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

java.lang.Object
  extended by com.atlassian.confluence.search.lucene.tasks.BaseContentIndexTask
All Implemented Interfaces:
IndexTask, ContentIndexTask

Deprecated. since 3.0.

@Deprecated
public abstract class BaseContentIndexTask
extends Object
implements ContentIndexTask

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


Field Summary
protected  AnyTypeDao anyTypeDao
          Deprecated. Required resource.
protected  com.atlassian.bonnie.search.DocumentBuilder documentBuilder
          Deprecated. Required resource.
protected  com.atlassian.bonnie.Handle handle
          Deprecated. The handle that identifies the searchable instance being indexed.
protected  String spaceKey
          Deprecated. The spacekey (if any) of the instance being indexed
protected  com.atlassian.bonnie.Searchable target
          Deprecated. The searchable subject of this index task.
 
Constructor Summary
protected BaseContentIndexTask()
          Deprecated.  
  BaseContentIndexTask(com.atlassian.bonnie.Searchable target)
          Deprecated. Create a new index task.
protected BaseContentIndexTask(String handle)
          Deprecated.  
 
Method Summary
protected  com.atlassian.bonnie.Handle createHandle(com.atlassian.bonnie.Searchable target)
          Deprecated.  
protected  com.atlassian.bonnie.Handle createHandle(String handle)
          Deprecated. 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(Object other)
          Deprecated. Two content index tasks are considered equal if they are of the same type and contain the same handle.
 com.atlassian.bonnie.Handle getHandle()
          Deprecated.  
 com.atlassian.bonnie.Searchable getTarget()
          Deprecated.  
 int hashCode()
          Deprecated.  
 void setAnyTypeDao(AnyTypeDao anyTypeDao)
          Deprecated. 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)
          Deprecated. Required resource for converting searchable instances into documents to be indexed.
 String toString()
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.atlassian.confluence.search.IndexTask
getDescription
 

Field Detail

documentBuilder

protected com.atlassian.bonnie.search.DocumentBuilder documentBuilder
Deprecated. 
Required resource. The document builder is used to create a lucene document from a searchable instance.


anyTypeDao

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


handle

protected com.atlassian.bonnie.Handle handle
Deprecated. 
The handle that identifies the searchable instance being indexed.


spaceKey

protected String spaceKey
Deprecated. 
The spacekey (if any) of the instance being indexed


target

protected transient com.atlassian.bonnie.Searchable target
Deprecated. 
The searchable subject of this index task.

Constructor Detail

BaseContentIndexTask

protected BaseContentIndexTask()
Deprecated. 

BaseContentIndexTask

public BaseContentIndexTask(com.atlassian.bonnie.Searchable target)
Deprecated. 
Create a new index task.

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

BaseContentIndexTask

protected BaseContentIndexTask(String handle)
                        throws ParseException
Deprecated. 
Throws:
ParseException
Method Detail

createHandle

protected com.atlassian.bonnie.Handle createHandle(String handle)
                                            throws ParseException
Deprecated. 
The default create handle implementation creates a handle that can be used to retrieve the searchable target from the persistent store via the
AnyTypeDao.findByHandle(handle);

Throws:
ParseException

getTarget

public com.atlassian.bonnie.Searchable getTarget()
Deprecated. 

getHandle

public com.atlassian.bonnie.Handle getHandle()
Deprecated. 
Specified by:
getHandle in interface ContentIndexTask

equals

public boolean equals(Object other)
Deprecated. 
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 Object

hashCode

public int hashCode()
Deprecated. 
Overrides:
hashCode in class Object

createHandle

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

setDocumentBuilder

public void setDocumentBuilder(com.atlassian.bonnie.search.DocumentBuilder documentBuilder)
Deprecated. 
Required resource for converting searchable instances into documents to be indexed.


setAnyTypeDao

public void setAnyTypeDao(AnyTypeDao anyTypeDao)
Deprecated. 
Required resource for converting handles into searchable instances so that the content to be indexed can be retrieved.


toString

public String toString()
Deprecated. 
Overrides:
toString in class Object


Copyright © 2003-2013 Atlassian. All Rights Reserved.