Package org.opencms.search

Class CmsSearchDocumentType

java.lang.Object

org.opencms.search.CmsSearchDocumentType

public class CmsSearchDocumentType
extends Object

A document type specifies which document factory class is used to pull the content of an OpenCms document into a Lucene index document.

The appropriate document factory class gets triggerd while the search index is built for OpenCms documents matching the specified resource type and/or mimetype combination in a document factory class instance.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsSearchDocumentType()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addMimeType(String mimeType)	Adds a mimetype.
void	addResourceType(String resourceType)	Adds the class name of a resource type.
String	getClassName()	Returns the name of the document factory class.
List<String>	getMimeTypes()	Returns the mimetypes to trigger the document factory class.
String	getName()	Returns the logical key/name of this document type.
List<String>	getResourceTypes()	Returns the list of Cms resource types to trigger the document factory.
void	setClassName(String className)	Sets the name of the document factory class.
void	setMimeTypes(List<String> mimetypes)	Sets the mimetypes to trigger the document factory class.
void	setName(String name)	Sets the logical key/name of this document type.
void	setResourceTypes(List<String> resourceTypes)	Sets the list of Cms resource types to trigger the document factory.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSearchDocumentType

public CmsSearchDocumentType()

Default constructor.

Method Details

addMimeType

public void addMimeType(String mimeType)

Adds a mimetype.

Parameters:

mimeType - a mimetype

addResourceType

public void addResourceType(String resourceType)

Adds the class name of a resource type.

Parameters:

resourceType - the class name of a resource type

getClassName

public String getClassName()

Returns the name of the document factory class.

Returns:

the name of the document factory class

getMimeTypes

public List<String> getMimeTypes()

Returns the mimetypes to trigger the document factory class.

Returns:

the mimetypes to trigger the document factory class

getName

public String getName()

Returns the logical key/name of this document type.

Returns:

the logical key/name of this document type

getResourceTypes

public List<String> getResourceTypes()

Returns the list of Cms resource types to trigger the document factory.

Returns:

the list of Cms resource types to trigger the document factory

setClassName

public void setClassName(String className)

Sets the name of the document factory class.

Parameters:

className - the name of the document factory class

setMimeTypes

public void setMimeTypes(List<String> mimetypes)

Sets the mimetypes to trigger the document factory class.

Parameters:

mimetypes - the mimetypes to trigger the document factory class

setName

public void setName(String name)

Sets the logical key/name of this document type.

Parameters:

name - the logical key/name of this document type

setResourceTypes

public void setResourceTypes(List<String> resourceTypes)

Sets the list of Cms resource types to trigger the document factory.

Parameters:

resourceTypes - the list of Cms resource types to trigger the document factory