Uses of Interface
org.opencms.search.I_CmsSearchDocument

Packages that use I_CmsSearchDocument

Package	Description
org.opencms.search	Implements the main full text search and indexing functions available in OpenCms.
org.opencms.search.documents	Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
org.opencms.search.fields	These classes control the mapping of the OpenCms content to the Lucene search fields.
org.opencms.search.galleries	Implements the search functions for the OpenCms Gallery search index, which is used by the Advanced Direct Edit (ADE) functions.
org.opencms.search.solr	The package contains the Solr search integration.

Uses of I_CmsSearchDocument in org.opencms.search

Classes in org.opencms.search that implement I_CmsSearchDocument

Modifier and Type	Class	Description
class	CmsLuceneDocument	A Lucene search document implementation.

Methods in org.opencms.search that return I_CmsSearchDocument

Modifier and Type	Method	Description
protected I_CmsSearchDocument	CmsIndexingThread.createDefaultIndexDocument()	Creates a document for the resource without extracting the content.
I_CmsSearchDocument	CmsSearchIndex.createEmptyDocument(CmsResource resource)	Creates an empty document that can be used by this search field configuration.
I_CmsSearchDocument	I_CmsSearchIndex.createEmptyDocument(CmsResource resource)	Creates an empty document that can be used by this search field configuration.
protected I_CmsSearchDocument	CmsIndexingThread.createIndexDocument(CmsObject cms, CmsResource res, I_CmsSearchIndex index, int count, I_CmsReport report)	Creates the search index document.
I_CmsSearchDocument	CmsSearchIndex.getDocument(int docId)	Returns a document by document ID.
I_CmsSearchDocument	CmsSearchIndex.getDocument(String field, String term)	Returns the first document where the given term matches the selected index field.
I_CmsSearchDocument	CmsSearchResource.getDocument()	Returns the document.
I_CmsSearchDocument	CmsIndexingThread.getResult()	Returns the document created by this indexer thread.

Methods in org.opencms.search with parameters of type I_CmsSearchDocument

Modifier and Type	Method	Description
protected CmsResource	CmsSearchIndex.getResource(CmsObject cms, I_CmsSearchDocument doc)	Checks if the OpenCms resource referenced by the result document can be read by the user of the given OpenCms context.
protected CmsResource	CmsSearchIndex.getResource(CmsObject cms, I_CmsSearchDocument doc, CmsResourceFilter filter)	Checks if the OpenCms resource referenced by the result document can be read by the user of the given OpenCms context.
protected boolean	CmsSearchIndex.hasReadPermission(CmsObject cms, I_CmsSearchDocument doc)	Checks if the OpenCms resource referenced by the result document can be read be the user of the given OpenCms context.
protected boolean	CmsSearchIndex.needsPermissionCheck(I_CmsSearchDocument doc)	Checks if the OpenCms resource referenced by the result document needs to be checked.
void	CmsLuceneIndexWriter.updateDocument(String rootPath, I_CmsSearchDocument document)
void	I_CmsIndexWriter.updateDocument(String rootPath, I_CmsSearchDocument document)	Update a document in the index.
protected void	CmsVfsIndexer.updateResource(I_CmsIndexWriter indexWriter, String rootPath, I_CmsSearchDocument doc)	Updates a resource with the given index writer and the new document provided.

Constructors in org.opencms.search with parameters of type I_CmsSearchDocument

Modifier	Constructor	Description
	CmsSearchResource(CmsResource resource, I_CmsSearchDocument doc)	Constructor, creates a new file Object from the given resource with an empty byte array as file content, if the resource does not implement a file.
	CmsSearchResource(CmsUUID structureId, CmsUUID resourceId, String path, int type, int flags, CmsUUID projectId, CmsResourceState state, long dateCreated, CmsUUID userCreated, long dateLastModified, CmsUUID userLastModified, long dateReleased, long dateExpired, int linkCount, int length, long dateContent, int version, I_CmsSearchDocument doc)	Constructor, creates a new file object.

Uses of I_CmsSearchDocument in org.opencms.search.documents

Methods in org.opencms.search.documents that return I_CmsSearchDocument

Modifier and Type	Method	Description
I_CmsSearchDocument	A_CmsVfsDocument.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Creates the Lucene Document for the given VFS resource and the given search index.
I_CmsSearchDocument	CmsDocumentContainerPage.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Generates a new lucene document instance from contents of the given resource for the provided index.
I_CmsSearchDocument	CmsDocumentXmlContent.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)
I_CmsSearchDocument	I_CmsDocumentFactory.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Creates the Lucene Document for the given VFS resource and the given search index.

Uses of I_CmsSearchDocument in org.opencms.search.fields

Methods in org.opencms.search.fields that return I_CmsSearchDocument

Modifier and Type	Method	Description
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Overriding this method allows to append some 'extra' values/fields to a document without overriding the CmsSearchFieldConfiguration.createDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.I_CmsSearchIndex, org.opencms.search.extractors.I_CmsExtractionResult) method itself.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfigurationOldCategories.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendContentBlob(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by a field that contains the extracted content blob.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by fields for date of creation, content and last modification.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField field, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the mappings for the given field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the configured field mappings.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFileSize(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the "size" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the "res_locales" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendPath(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by fields for VFS path lookup.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Appends all direct properties, that are not empty or white space only to the document.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendType(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by a field that contains the resource type name.
I_CmsSearchDocument	CmsSearchFieldConfiguration.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, I_CmsExtractionResult extraction)	Creates the Lucene Document with this field configuration for the provided VFS resource, search index and content.
I_CmsSearchDocument	I_CmsSearchFieldConfiguration.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, I_CmsExtractionResult extractionResult)	Creates the document to index.

Methods in org.opencms.search.fields with parameters of type I_CmsSearchDocument

Modifier and Type	Method	Description
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Overriding this method allows to append some 'extra' values/fields to a document without overriding the CmsSearchFieldConfiguration.createDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.I_CmsSearchIndex, org.opencms.search.extractors.I_CmsExtractionResult) method itself.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfigurationOldCategories.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendContentBlob(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by a field that contains the extracted content blob.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by fields for date of creation, content and last modification.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField field, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the mappings for the given field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the configured field mappings.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFileSize(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the "size" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the "res_locales" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendPath(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by fields for VFS path lookup.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Appends all direct properties, that are not empty or white space only to the document.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendType(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by a field that contains the resource type name.

Uses of I_CmsSearchDocument in org.opencms.search.galleries

Constructors in org.opencms.search.galleries with parameters of type I_CmsSearchDocument

Modifier	Constructor	Description
	CmsGallerySearchResult(I_CmsSearchDocument doc, CmsObject cms, int score, Locale locale)	Creates a new gallery search result.

Uses of I_CmsSearchDocument in org.opencms.search.solr

Classes in org.opencms.search.solr that implement I_CmsSearchDocument

Modifier and Type	Class	Description
class	CmsSolrDocument	A search document implementation for Solr indexes.

Methods in org.opencms.search.solr that return I_CmsSearchDocument

Modifier and Type	Method	Description
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField sfield, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappingsFromElementsOnThePage(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, List<String> systemFields)	Adds search fields from elements on a container page to a container page's document.
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
I_CmsSearchDocument	CmsSolrIndex.createEmptyDocument(CmsResource resource)
I_CmsSearchDocument	CmsSolrIndex.getDocument(String fieldname, String term)
I_CmsSearchDocument	CmsSolrIndex.getDocument(String fieldname, String term, String[] fls)	Version of CmsSearchIndex.getDocument(java.lang.String, java.lang.String) where the returned fields can be restricted.

Methods in org.opencms.search.solr with parameters of type I_CmsSearchDocument

Modifier and Type	Method	Description
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField sfield, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappingsFromElementsOnThePage(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, List<String> systemFields)	Adds search fields from elements on a container page to a container page's document.
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
void	CmsSolrIndexWriter.updateDocument(String rootPath, I_CmsSearchDocument document)
void	CmsSolrIndexWriter.updateDocument(I_CmsSearchDocument searchDocument)	Updates a search document without removing it beforehand.