org.nuxeo.ecm.core.search.api.client.indexing.resources.document.schemas
Class DefaultSchemaFieldDescriptorsFactory

java.lang.Object
  org.nuxeo.ecm.core.search.api.client.indexing.resources.document.schemas.DefaultSchemaFieldDescriptorsFactory

public final class DefaultSchemaFieldDescriptorsFactory
extends java.lang.Object

Default schema field descriptors factory.

Generates default schema field descriptors. This is invoked when no explicit indexing schema and / or field configurations are contributed.

Author:

Julien Anguenot

See Also:

IndexableResourcesFactory

Constructor Summary

DefaultSchemaFieldDescriptorsFactory()

Method Summary

java.util.List<IndexableFieldDescriptor>	getFieldDescriptorsBySchemaName(java.lang.String name, java.util.Set<java.lang.String> excludeFields) Returns the list of indexable field descriptor for a given schema name.
java.util.List<IndexableFieldDescriptor>	getFieldDescriptorsBySchemaPrefix(java.lang.String prefix, java.util.Set<java.lang.String> excludeFields) Returns the list of indexable field descriptor for a schema given its prefix.
Schema	getSchemaByName(java.lang.String name) Returns a schema given its name.
Schema	getSchemaByPrefix(java.lang.String prefix) Returns a schema given its prefix.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSchemaFieldDescriptorsFactory

public DefaultSchemaFieldDescriptorsFactory()

Method Detail

getSchemaByPrefix

public Schema getSchemaByPrefix(java.lang.String prefix)

Returns a schema given its prefix.

Parameters:

prefix - the schema prefix

Returns:

a Nuxeo core schema instance

getSchemaByName

public Schema getSchemaByName(java.lang.String name)

Returns a schema given its name.

Parameters:

name - the schema name

Returns:

a Nuxeo core schema instance.

getFieldDescriptorsBySchemaName

public java.util.List<IndexableFieldDescriptor> getFieldDescriptorsBySchemaName(java.lang.String name,
                                                                                java.util.Set<java.lang.String> excludeFields)

Returns the list of indexable field descriptor for a given schema name.

Parameters:

name - the schema name

excludeFields - explicitly exclude those field names.

Returns:

a list of indexable field descriptor instances.

getFieldDescriptorsBySchemaPrefix

public java.util.List<IndexableFieldDescriptor> getFieldDescriptorsBySchemaPrefix(java.lang.String prefix,
                                                                                  java.util.Set<java.lang.String> excludeFields)

Returns the list of indexable field descriptor for a schema given its prefix.

Parameters:

prefix - the schema prefix

excludeFields - explicitly exclude those field names.

Returns:

a list of indexable field descriptor instances.