com.xpn.xwiki.plugin.lucene
Class AbstractDocumentData

java.lang.Object
  com.xpn.xwiki.plugin.lucene.AbstractIndexData
      com.xpn.xwiki.plugin.lucene.AbstractDocumentData

Direct Known Subclasses:

AttachmentData, DocumentData

public abstract class AbstractDocumentData
extends AbstractIndexData

Since:

1.23

Version:

$Id$

Constructor Summary

AbstractDocumentData(java.lang.String type, com.xpn.xwiki.doc.XWikiDocument doc, XWikiContext context, boolean deleted)

Method Summary

void	addDataToLuceneDocument(org.apache.lucene.document.Document luceneDoc, XWikiContext context) Adds this documents data to a lucene Document instance for indexing.
void	addDocumentDataToLuceneDocument(org.apache.lucene.document.Document luceneDoc, com.xpn.xwiki.doc.XWikiDocument doc, XWikiContext context)
java.util.Date	getCreationDate()
java.lang.String	getCreator()
java.lang.String	getDocumentFullName()
java.lang.String	getDocumentName()
DocumentReference	getDocumentReference()
java.lang.String	getDocumentSpace()
java.lang.String	getDocumentTitle()
java.lang.String	getFullName()
protected void	getFullText(java.lang.StringBuilder sb, com.xpn.xwiki.doc.XWikiDocument doc, XWikiContext context)
java.lang.String	getFullText(com.xpn.xwiki.doc.XWikiDocument doc, XWikiContext context)
java.lang.String	getId()
java.lang.String	getLanguage()
org.apache.lucene.index.Term	getTerm()
java.lang.String	getWiki()
void	setAuthor(java.lang.String author)
void	setCreationDate(java.util.Date creationDate)
void	setCreator(java.lang.String creator)
void	setDocumentTitle(java.lang.String documentTitle)
void	setLanguage(java.lang.String lang)
void	setModificationDate(java.util.Date modificationDate)
java.lang.String	toString()

Methods inherited from class com.xpn.xwiki.plugin.lucene.AbstractIndexData

getEntityName, getEntityReference, getType, isDeleted, setDeleted, setEntityReference

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDocumentData

public AbstractDocumentData(java.lang.String type,
                            com.xpn.xwiki.doc.XWikiDocument doc,
                            XWikiContext context,
                            boolean deleted)

Method Detail

addDataToLuceneDocument

public void addDataToLuceneDocument(org.apache.lucene.document.Document luceneDoc,
                                    XWikiContext context)
                             throws XWikiException

Adds this documents data to a lucene Document instance for indexing.

Short introduction to Lucene field types

Which type of Lucene field is used determines what Lucene does with data and how we can use it for searching and showing search results:

• Keyword fields don't get tokenized, but are searchable and stored in the index. This is perfect for fields you want to search in programmatically (like ids and such), and date fields. Since all user-entered queries are tokenized, letting the user search these fields makes almost no sense, except of queries for date fields, where tokenization is useless.
• the stored text fields are used for short texts which should be searchable by the user, and stored in the index for reconstruction. Perfect for document names, titles, abstracts.
• the unstored field takes the biggest part of the content - the full text. It is tokenized and indexed, but not stored in the index. This makes sense, since when the user wants to see the full content, he clicks the link to vie the full version of a document, which is then delivered by xwiki.

Overrides:

addDataToLuceneDocument in class AbstractIndexData

Parameters:

luceneDoc - if not null, this controls which translated version of the content will be indexed. If null, the content in the default language will be used.

Throws:

XWikiException

addDocumentDataToLuceneDocument

public void addDocumentDataToLuceneDocument(org.apache.lucene.document.Document luceneDoc,
                                            com.xpn.xwiki.doc.XWikiDocument doc,
                                            XWikiContext context)

getId

public java.lang.String getId()

Specified by:

getId in class AbstractIndexData

Returns:

string unique to this document across all languages and virtual wikis

getTerm

public org.apache.lucene.index.Term getTerm()

Overrides:

getTerm in class AbstractIndexData

getFullText

public java.lang.String getFullText(com.xpn.xwiki.doc.XWikiDocument doc,
                                    XWikiContext context)

Overrides:

getFullText in class AbstractIndexData

Returns:

String of documentName, documentWeb, author and creator

getFullText

protected void getFullText(java.lang.StringBuilder sb,
                           com.xpn.xwiki.doc.XWikiDocument doc,
                           XWikiContext context)

Specified by:

getFullText in class AbstractIndexData

setAuthor

public void setAuthor(java.lang.String author)

Parameters:

author - The author to set.

setDocumentTitle

public void setDocumentTitle(java.lang.String documentTitle)

Parameters:

documentTitle - the document title

setModificationDate

public void setModificationDate(java.util.Date modificationDate)

Parameters:

modificationDate - The modificationDate to set.

getDocumentTitle

public java.lang.String getDocumentTitle()

getDocumentReference

public DocumentReference getDocumentReference()

getDocumentName

public java.lang.String getDocumentName()

Overrides:

getDocumentName in class AbstractIndexData

getDocumentSpace

public java.lang.String getDocumentSpace()

Overrides:

getDocumentSpace in class AbstractIndexData

getWiki

public java.lang.String getWiki()

Overrides:

getWiki in class AbstractIndexData

getDocumentFullName

public java.lang.String getDocumentFullName()

Overrides:

getDocumentFullName in class AbstractIndexData

getCreationDate

public java.util.Date getCreationDate()

setCreationDate

public void setCreationDate(java.util.Date creationDate)

getCreator

public java.lang.String getCreator()

setCreator

public void setCreator(java.lang.String creator)

getFullName

public java.lang.String getFullName()

Overrides:

getFullName in class AbstractIndexData

getLanguage

public java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String lang)

toString

public java.lang.String toString()

Overrides:

toString in class AbstractIndexData