Class FullIndexEntry
- java.lang.Object
-
- org.silverpeas.core.index.indexing.model.IndexEntry
-
- org.silverpeas.core.index.indexing.model.FullIndexEntry
-
- All Implemented Interfaces:
Serializable
public class FullIndexEntry extends IndexEntry implements Serializable
A FullIndexEntry is an IndexEntry completed with data useful 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.core.index.indexing.model.IndexEntry
END_DATE_DEFAULT, START_DATE_DEFAULT
-
-
Constructor Summary
Constructors Constructor Description FullIndexEntry(IndexEntryKey pk)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addField(String fieldName, String value)
void
addField(String fieldName, String value, String language, boolean stored)
void
addField(String fieldName, Date value)
void
addField(String fieldName, Date value, String language)
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)
boolean
equals(Object o)
To be equal two IndexEntry must have the same PK.FullIndexEntry
getCopy()
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.int
hashCode()
Returns the hash code of the indexEntry.-
Methods inherited from class org.silverpeas.core.index.indexing.model.IndexEntry
getComponent, getCreationDate, getCreationUser, getEndDate, getFilename, getKeywords, getKeywords, getLang, getLanguages, getLastModificationDate, getLastModificationUser, getLinkedObjectId, getObjectId, getObjectType, getPaths, getPK, getPreview, getPreview, getServerName, getStartDate, getThumbnail, getThumbnailDirectory, getThumbnailMimeType, getTitle, getTitle, isAlias, isIndexId, isLinkedObject, setAlias, setCreationDate, setCreationDate, setCreationUser, setEndDate, setEndDate, setFilename, setIndexId, setKeywords, setKeywords, setLang, setLastModificationDate, setLastModificationDate, setLastModificationUser, setPaths, setPK, setPreview, setPreview, setServerName, setStartDate, setStartDate, setThumbnail, setThumbnailDirectory, setThumbnailMimeType, setTitle, setTitle, toString
-
-
-
-
Constructor Detail
-
FullIndexEntry
public FullIndexEntry(IndexEntryKey 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.
-
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
-
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
-
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.
-
getFields
public List<FieldDescription> getFields()
-
getCopy
public FullIndexEntry getCopy()
-
equals
public boolean equals(Object o)
Description copied from class:IndexEntry
To be equal two IndexEntry must have the same PK. The equals method is redefined so IndexEntry objects can be put in a Set or used as Map key.- Overrides:
equals
in classIndexEntry
-
hashCode
public int hashCode()
Description copied from class:IndexEntry
Returns the hash code of the indexEntry. The hashCode method is redefined so IndexEntry objects can be put in a Set or used as Map key. Only the primary key is used to compute the hash code, as only the primary key is used to compare two entries.- Overrides:
hashCode
in classIndexEntry
-
-