|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.search.v2.lucene.LuceneSearchResult
public class LuceneSearchResult
Constructor Summary | |
---|---|
LuceneSearchResult(org.apache.lucene.search.Hit hit)
Constructor to create a search result directly from a Lucene hit |
|
LuceneSearchResult(java.util.Map results)
Helper constructor for use in tests. |
Method Summary | |
---|---|
java.lang.String |
getContent()
Gets the text content of the search result. |
java.util.Date |
getCreationDate()
|
java.lang.String |
getCreator()
|
java.lang.String |
getDisplayTitle()
Gets the title of the search result appropriate for displaying to a user. |
com.atlassian.bonnie.Handle |
getHandle()
Retrieves the handle that can then be used by the AnyTypeObjectDao to retrieve the database object referenced by this search result. |
java.util.Date |
getLastModificationDate()
Gets the last modification date of the entity represented by the search result. |
java.lang.String |
getLastModifier()
Gets the username of the last person to modify the entity represented by the search result. |
java.lang.String |
getLastUpdateDescription()
Gets some string describing the last modification to this content. |
java.lang.String |
getType()
Gets a string representation of the type of the entity represented by the search result. |
java.lang.String |
getUrlPath()
Gets the URL path to the search result, relative to the site's context root. |
boolean |
isHomePage()
Checks if the search result represents the homepage of a space. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LuceneSearchResult(org.apache.lucene.search.Hit hit) throws java.io.IOException
hit
- the Lucene hit behind this result
java.io.IOException
- if something goes wrong getting data from the hitpublic LuceneSearchResult(java.util.Map results)
results
- the already-converted map of resultsMethod Detail |
---|
public com.atlassian.bonnie.Handle getHandle()
SearchResult
Because the database and index are not updated at the same time, it is possible for a deleted entity to still be represented in the search index. Do not assume that this handle will always refer to a live object.
getHandle
in interface SearchResult
AnyTypeObjectDao.findByHandle(com.atlassian.bonnie.Handle)
public java.lang.String getContent()
SearchResult
getContent
in interface SearchResult
public java.lang.String getType()
SearchResult
ContentEntityObject.getType()
getType
in interface SearchResult
Addressable.getType()
public boolean isHomePage()
SearchResult
isHomePage
in interface SearchResult
public java.util.Date getCreationDate()
getCreationDate
in interface SearchResult
public java.lang.String getCreator()
getCreator
in interface SearchResult
public java.util.Date getLastModificationDate()
SearchResult
getLastModificationDate
in interface SearchResult
public java.lang.String getLastModifier()
SearchResult
getLastModifier
in interface SearchResult
public java.lang.String getDisplayTitle()
SearchResult
getDisplayTitle
in interface SearchResult
Addressable.getDisplayTitle()
public java.lang.String getUrlPath()
SearchResult
getUrlPath
in interface SearchResult
Addressable.getUrlPath()
public java.lang.String getLastUpdateDescription()
SearchResult
This string is user-supplied, and therefore not internationalised
getLastUpdateDescription
in interface SearchResult
ContentEntityObject.getVersionComment()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |