org.silverpeas.search.indexEngine.model
Class FullIndexEntry

java.lang.Object
  org.silverpeas.search.indexEngine.model.IndexEntry
      org.silverpeas.search.indexEngine.model.FullIndexEntry

All Implemented Interfaces:

Serializable, Cloneable

public class FullIndexEntry
extends IndexEntry
implements Serializable, Cloneable

A FullIndexEntry is an IndexEntry completed with data usefull uniquely at the index creation time (mainly all the data contents which must be indexed but which is useless at retrieve time). This extra-content is indexed but not stored in the index.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.silverpeas.search.indexEngine.model.IndexEntry

ENDDATE_DEFAULT, STARTDATE_DEFAULT

Constructor Summary

FullIndexEntry(IndexEntryPK pk)

FullIndexEntry(String component, String objectType, String objectId)

FullIndexEntry(String space, String component, String objectType, String objectId)
Deprecated. - parameter space is no more used

Method Summary

void	addField(String fieldName, Date value)
void	addField(String fieldName, Date value, String language)
void	addField(String fieldName, String value)
void	addField(String fieldName, String value, String language, boolean stored)
void	addFileContent(String path, String encoding, String format, String lang) Add a file to be indexed.
void	addLinkedFileContent(String path, String encoding, String format, String lang) Add a linked file to be indexed.
void	addLinkedFileId(String fileId) Add a linked file id to be indexed.
void	addTextContent(String text) Add a text fragment to be indexed.
void	addTextContent(String text, String language)
void	addXMLField(String fieldName, String value) Deprecated. use addField(String fieldName, String value) instead
void	addXMLField(String fieldName, String value, String language) Deprecated. use addField(String fieldName, String value, String language) instead
FullIndexEntry	clone()
List<FieldDescription>	getFields()
List<FileDescription>	getFileContentList() Return the List of all the added files.
List<FileDescription>	getLinkedFileContentList() Return the List of all the linked files.
Set<String>	getLinkedFileIdsSet()
List<TextDescription>	getTextContentList() Return the List of all the added texts.
List<FieldDescription>	getXmlFields() Deprecated. use getFields() instead

Methods inherited from class org.silverpeas.search.indexEngine.model.IndexEntry

equals, getComponent, getCreationDate, getCreationUser, getEndDate, getFilename, getKeyWords, getKeywords, getLang, getLanguages, getLastModificationDate, getLastModificationUser, getObjectId, getObjectType, getPaths, getPK, getPreView, getPreview, getServerName, getStartDate, getThumbnail, getThumbnailDirectory, getThumbnailMimeType, getTitle, getTitle, hashCode, isAlias, isIndexId, setAlias, setCreationDate, setCreationDate, setCreationUser, setEndDate, setFilename, setIndexId, setKeyWords, setKeywords, setLang, setLastModificationDate, setLastModificationDate, setLastModificationUser, setPaths, setPK, setPreView, setPreview, setServerName, setStartDate, setThumbnail, setThumbnailDirectory, setThumbnailMimeType, setTitle, setTitle, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FullIndexEntry

public FullIndexEntry(String space,
                      String component,
                      String objectType,
                      String objectId)

Deprecated. - parameter space is no more used

The constructor only set the key part of the IndexEntry.

FullIndexEntry

public FullIndexEntry(String component,
                      String objectType,
                      String objectId)

FullIndexEntry

public FullIndexEntry(IndexEntryPK pk)

Method Detail

addTextContent

public void addTextContent(String text)

Add a text fragment to be indexed. All this text fragments will be indexed but not stored in the index. They may be added in any order.

addTextContent

public void addTextContent(String text,
                           String language)

addFileContent

public void addFileContent(String path,
                           String encoding,
                           String format,
                           String lang)

Add a file to be indexed. We need :

• the path to the file
• the encoding of the file
• the format of the file
• the language of the file

All this files will be parsed and then indexed but not stored in the index. They may be added in any order.

addLinkedFileId

public void addLinkedFileId(String fileId)

Add a linked file id to be indexed. We need :

• the file id

addLinkedFileContent

public void addLinkedFileContent(String path,
                                 String encoding,
                                 String format,
                                 String lang)

Add a linked file to be indexed. We need :

• the path to the file
• the encoding of the file
• the format of the file
• the language of the file

All this files will be parsed and then indexed but not stored in the index. They may be added in any order.

addXMLField

public void addXMLField(String fieldName,
                        String value)

Deprecated. use addField(String fieldName, String value) instead

addXMLField

public void addXMLField(String fieldName,
                        String value,
                        String language)

Deprecated. use addField(String fieldName, String value, String language) instead

addField

public void addField(String fieldName,
                     String value)

addField

public void addField(String fieldName,
                     String value,
                     String language,
                     boolean stored)

addField

public void addField(String fieldName,
                     Date value)

addField

public void addField(String fieldName,
                     Date value,
                     String language)

getTextContentList

public List<TextDescription> getTextContentList()

Return the List of all the added texts. The returned List is a list of String.

getFileContentList

public List<FileDescription> getFileContentList()

Return the List of all the added files. The returned List is a list of FileDescription.

getLinkedFileContentList

public List<FileDescription> getLinkedFileContentList()

Return the List of all the linked files. The returned List is a list of FileDescription.

getXmlFields

public List<FieldDescription> getXmlFields()

Deprecated. use getFields() instead

getLinkedFileIdsSet

public Set<String> getLinkedFileIdsSet()

getFields

public List<FieldDescription> getFields()

clone

public FullIndexEntry clone()

Overrides:

clone in class IndexEntry