org.nuxeo.ecm.core.search.api.indexing.resources.configuration
Class IndexableResourceDescriptor

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

All Implemented Interfaces:

Serializable, IndexableResourceConf

public class IndexableResourceDescriptor
extends Object
implements IndexableResourceConf

Indexable document descriptor.

Author:

Julien Anguenot

See Also:

Serialized Form

Field Summary

protected boolean	allFieldsIndexable
protected Set<String>	excludedFields
protected Map<String,IndexableResourceDataConf>	fields
protected String	name
protected String	prefix
protected String	type

Constructor Summary

IndexableResourceDescriptor()

IndexableResourceDescriptor(String name, String prefix, boolean allFieldsIndexable, Set<String> excludedFields, Map<String,IndexableResourceDataConf> fields, String type)

Method Summary

boolean	areAllFieldsIndexable() All schema fields should be indexed ?
Set<String>	getExcludedFields() Returns the list of field that should be excluded.
Map<String,IndexableResourceDataConf>	getIndexableFields() Returns the map from field name to indexable schema field configuration.
String	getName() Returns the name of the indexable resource c onfiguration.
String	getPrefix() Returns the resource prefix.
String	getType() Returns the indexable resource type.
void	setAllFieldsIndexable(boolean allFieldsIndexable)
void	setExcludedFields(Set<String> excludedFields)
void	setFields(Map<String,IndexableResourceDataConf> fields)
void	setName(String name)
void	setPrefix(String schemaPrefix)
void	setType(String type)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

prefix

protected String prefix

type

protected String type

allFieldsIndexable

protected boolean allFieldsIndexable

excludedFields

protected Set<String> excludedFields

fields

protected Map<String,IndexableResourceDataConf> fields

Constructor Detail

IndexableResourceDescriptor

public IndexableResourceDescriptor()

IndexableResourceDescriptor

public IndexableResourceDescriptor(String name,
                                   String prefix,
                                   boolean allFieldsIndexable,
                                   Set<String> excludedFields,
                                   Map<String,IndexableResourceDataConf> fields,
                                   String type)

Method Detail

getName

public String getName()

Description copied from interface: IndexableResourceConf

Returns the name of the indexable resource c onfiguration.

Specified by:

getName in interface IndexableResourceConf

Returns:

the name of the indexable resource configuration.

setName

public void setName(String name)

getIndexableFields

public Map<String,IndexableResourceDataConf> getIndexableFields()

Description copied from interface: IndexableResourceConf

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

Specified by:

getIndexableFields in interface IndexableResourceConf

Returns:

the map from field name to indexable field configuration.

setFields

public void setFields(Map<String,IndexableResourceDataConf> fields)

getPrefix

public String getPrefix()

Description copied from interface: IndexableResourceConf

Returns the resource prefix.

Specified by:

getPrefix in interface IndexableResourceConf

Returns:

the resource prefix.

setPrefix

public void setPrefix(String schemaPrefix)

areAllFieldsIndexable

public boolean areAllFieldsIndexable()

Description copied from interface: IndexableResourceConf

All schema fields should be indexed ?

Specified by:

areAllFieldsIndexable in interface IndexableResourceConf

Returns:

true if all fields should be indexed.

setAllFieldsIndexable

public void setAllFieldsIndexable(boolean allFieldsIndexable)

getExcludedFields

public Set<String> getExcludedFields()

Description copied from interface: IndexableResourceConf

Returns the list of field that should be excluded.

Specified by:

getExcludedFields in interface IndexableResourceConf

Returns:

a list of schema field names.

setExcludedFields

public void setExcludedFields(Set<String> excludedFields)

getType

public String getType()

Description copied from interface: IndexableResourceConf

Returns the indexable resource type.

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

Specified by:

getType in interface IndexableResourceConf

Returns:

a string identifier.

setType

public void setType(String type)

toString

public String toString()

Overrides:

toString in class Object