org.nuxeo.ecm.core.search.api.indexing.resources.configuration.document
Class IndexableDocTypeDescriptor

java.lang.Object
  org.nuxeo.ecm.core.search.api.indexing.resources.configuration.document.IndexableDocTypeDescriptor

All Implemented Interfaces:

Serializable, IndexableDocType

public class IndexableDocTypeDescriptor
extends Object
implements IndexableDocType

Indexable doc type descriptor.

Defines what type of resources needs to be taken into consideraton while indexing a Nuxeo core document given its docType.

Author:

Julien Anguenot

See Also:

Serialized Form

Field Summary

protected boolean	allFieldsSortable
protected boolean	allSchemasIndexable
protected List<String>	excludedSchemas
protected List<String>	resources
protected String	type

Constructor Summary

IndexableDocTypeDescriptor()

Method Summary

boolean	areAllFieldsSortable() All fields sortable ?
boolean	areAllSchemasIndexable() All schemas should be indexed ?
List<String>	getExcludedSchemas() Returns explicit schemas that should be excluded.
List<String>	getResources() Returns the list of resources to take into consideration while indexing.
String	getType() Return the doc type.
void	setAllFieldsSortable(boolean allFieldsSortable)
void	setAllSchemasIndexable(boolean allSchemasIndexable)
void	setExcludedSchemas(List<String> excludedSchemas)
void	setResources(List<String> resources)
void	setType(String type)

Methods inherited from class java.lang.Object

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

Field Detail

type

protected String type

allSchemasIndexable

protected boolean allSchemasIndexable

allFieldsSortable

protected boolean allFieldsSortable

excludedSchemas

protected List<String> excludedSchemas

resources

protected List<String> resources

Constructor Detail

IndexableDocTypeDescriptor

public IndexableDocTypeDescriptor()

Method Detail

getType

public String getType()

Description copied from interface: IndexableDocType

Return the doc type.

Specified by:

getType in interface IndexableDocType

Returns:

the doc type.

setType

public void setType(String type)

getResources

public List<String> getResources()

Description copied from interface: IndexableDocType

Returns the list of resources to take into consideration while indexing.

Specified by:

getResources in interface IndexableDocType

Returns:

a list of resource names.

setResources

public void setResources(List<String> resources)

areAllSchemasIndexable

public boolean areAllSchemasIndexable()

Description copied from interface: IndexableDocType

All schemas should be indexed ?

Specified by:

areAllSchemasIndexable in interface IndexableDocType

Returns:

true if all schemas are indexable.

setAllSchemasIndexable

public void setAllSchemasIndexable(boolean allSchemasIndexable)

getExcludedSchemas

public List<String> getExcludedSchemas()

Description copied from interface: IndexableDocType

Returns explicit schemas that should be excluded.

Specified by:

getExcludedSchemas in interface IndexableDocType

Returns:

a list of schema names.

setExcludedSchemas

public void setExcludedSchemas(List<String> excludedSchemas)

areAllFieldsSortable

public boolean areAllFieldsSortable()

Description copied from interface: IndexableDocType

All fields sortable ?

Specified by:

areAllFieldsSortable in interface IndexableDocType

Returns:

true if all fields should be sortable unless an explicit configuration specifies the contrary

setAllFieldsSortable

public void setAllFieldsSortable(boolean allFieldsSortable)