|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Implementation interface for lucene document factories used in OpenCms.
Field Summary | |
static java.lang.String |
DOC_CATEGORY
Contains the (optional) category of the document. |
static java.lang.String |
DOC_CONTENT
Search field for document content. |
static java.lang.String |
DOC_DATE_CREATED
Search field for document creation date. |
static java.lang.String |
DOC_DATE_LASTMODIFIED
Search field for document last update. |
static java.lang.String |
DOC_DESCRIPTION
Search field for document description. |
static java.lang.String |
DOC_KEYWORDS
Search field for document keywords. |
static java.lang.String |
DOC_META
Combines all document "meta" information, that is "title", "keywords" and "description". |
static java.lang.String |
DOC_PATH
Contains the document root path in the VFS. |
static java.lang.String |
DOC_PRIORITY
Contains the (optional) document priority, which can be used to boost the document in the result list. |
static java.lang.String |
DOC_ROOT
Contains a special format of the document root path in the VFS for optimized searches. |
static java.lang.String |
DOC_TITLE_INDEXED
Contains the document title in an analyzed form used for searching in the title. |
static java.lang.String |
DOC_TITLE_KEY
Contains the document title as a keyword used for sorting and also for retrieving the title text. |
static java.lang.String |
DOC_TYPE
Contains the type of the document. |
static java.lang.String |
SEARCH_PRIORITY_HIGH_VALUE
Value for "high" search priority. |
static java.lang.String |
SEARCH_PRIORITY_LOW_VALUE
Value for "low" search priority. |
static java.lang.String |
SEARCH_PRIORITY_MAX_VALUE
Value for "maximum" search priority. |
static java.lang.String |
SEARCH_PRIORITY_NORMAL_VALUE
Value for "normal" search priority. |
Method Summary | |
java.lang.String |
getDocumentKey(java.lang.String resourceType)
Returns the document key for the search manager. |
java.util.List |
getDocumentKeys(java.util.List resourceTypes,
java.util.List mimeTypes)
Returns a list of document keys for the documenttype. |
java.lang.String |
getName()
Returns the name of the documenttype. |
org.apache.lucene.document.Document |
newInstance(CmsObject cms,
A_CmsIndexResource resource,
java.lang.String language)
Creates a new instance of a lucene document type for the concrete file type. |
Methods inherited from interface org.opencms.search.documents.I_CmsSearchExtractor |
extractContent |
Field Detail |
public static final java.lang.String DOC_CATEGORY
public static final java.lang.String DOC_CONTENT
public static final java.lang.String DOC_DATE_CREATED
public static final java.lang.String DOC_DATE_LASTMODIFIED
public static final java.lang.String DOC_DESCRIPTION
public static final java.lang.String DOC_KEYWORDS
public static final java.lang.String DOC_META
public static final java.lang.String DOC_PATH
public static final java.lang.String DOC_PRIORITY
public static final java.lang.String DOC_ROOT
public static final java.lang.String DOC_TITLE_INDEXED
public static final java.lang.String DOC_TITLE_KEY
public static final java.lang.String DOC_TYPE
public static final java.lang.String SEARCH_PRIORITY_HIGH_VALUE
public static final java.lang.String SEARCH_PRIORITY_LOW_VALUE
public static final java.lang.String SEARCH_PRIORITY_MAX_VALUE
public static final java.lang.String SEARCH_PRIORITY_NORMAL_VALUE
Method Detail |
public java.lang.String getDocumentKey(java.lang.String resourceType) throws CmsException
resourceType
- the resource type to get the document key for
CmsException
- if something goes wrongpublic java.util.List getDocumentKeys(java.util.List resourceTypes, java.util.List mimeTypes) throws CmsException
The list of accepted resource types may contain a catch-all entry "*"; in this case, a list for all possible resource types is returned, calculated by a logic depending on the document handler class.
resourceTypes
- list of accepted resource typesmimeTypes
- list of accepted mime types
CmsException
- if something goes wrongpublic java.lang.String getName()
public org.apache.lucene.document.Document newInstance(CmsObject cms, A_CmsIndexResource resource, java.lang.String language) throws CmsException
cms
- the cms objectresource
- a cms resourcelanguage
- the requested language
CmsException
- if something goes wrong
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |