org.nuxeo.ecm.core.search.api.indexing.resources.configuration
Interface IndexableResourceConf

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

FakeIndexableDocResourceConf, IndexableResourceDescriptor

public interface IndexableResourceConf
extends java.io.Serializable

Indexable resource configuration.

Base interface for all indexable resource candidates.

Author:

Julien Anguenot

See Also:

IndexableResource

Method Summary

boolean	areAllFieldsIndexable() All schema fields should be indexed ?
java.util.Set<java.lang.String>	getExcludedFields() Returns the list of field that should be excluded.
java.util.Map<java.lang.String,IndexableResourceDataConf>	getIndexableFields() Returns the map from field name to indexable schema field configuration.
java.lang.String	getName() Returns the name of the indexable resource c onfiguration.
java.lang.String	getPrefix() Returns the resource prefix.
java.lang.String	getType() Returns the indexable resource type.

Method Detail

getName

java.lang.String getName()

Returns the name of the indexable resource c onfiguration.

Returns:

the name of the indexable resource configuration.

getPrefix

java.lang.String getPrefix()

Returns the resource prefix.

Returns:

the resource prefix.

getIndexableFields

java.util.Map<java.lang.String,IndexableResourceDataConf> getIndexableFields()

Returns the map from field name to indexable schema field configuration.

Returns:

the map from field name to indexable field configuration.

areAllFieldsIndexable

boolean areAllFieldsIndexable()

All schema fields should be indexed ?

Returns:

true if all fields should be indexed.

getExcludedFields

java.util.Set<java.lang.String> getExcludedFields()

Returns the list of field that should be excluded.

Returns:

a list of schema field names.

getType

java.lang.String getType()

Returns the indexable resource type.

The type will be use for further indexing resource introspection if needed.

Returns:

a string identifier.