org.nuxeo.ecm.core.search.api.client.indexing.resources
Class AbstractIndexableResourceFactory

java.lang.Object
  org.nuxeo.ecm.core.search.api.client.indexing.resources.AbstractIndexableResourceFactory

All Implemented Interfaces:

java.io.Serializable, IndexableResourceFactory

Direct Known Subclasses:

AuditIndexableResourceFactory, DocumentBuiltinsIndexableResourceFactory, DocumentIndexableResourceFactory, DocumentIndexableResourceFactory

public abstract class AbstractIndexableResourceFactory
extends java.lang.Object
implements IndexableResourceFactory

Abstract indexable resource factory.

Author:

Julien Anguenot

See Also:

Serialized Form

Constructor Summary

AbstractIndexableResourceFactory()

Method Summary

ResolvedResource	createResolvedResourceFor(java.io.Serializable targetResource, IndexableResourceConf conf, java.lang.String sid) Resolves and returns an indexable resource instance.
ResolvedResources	createResolvedResourcesFor(java.io.Serializable targetResource, IndexableResourceConf conf, java.lang.String sid) Resolves an indexable resources and returns an aggregated resolved resources instances.
ResolvedResource	resolveResourceFor(java.io.Serializable targetResource, IndexableResourceConf conf, java.lang.String sid) Resolves and returns an indexable resource instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.search.api.client.indexing.resources.factory.IndexableResourceFactory

createEmptyIndexableResource, createIndexableResourceFrom, resolveResourceFor, resolveResourcesFor

Constructor Detail

AbstractIndexableResourceFactory

public AbstractIndexableResourceFactory()

Method Detail

resolveResourceFor

public ResolvedResource resolveResourceFor(java.io.Serializable targetResource,
                                           IndexableResourceConf conf,
                                           java.lang.String sid)
                                    throws IndexingException

Description copied from interface: IndexableResourceFactory

Resolves and returns an indexable resource instance.

Specified by:

resolveResourceFor in interface IndexableResourceFactory

Parameters:

targetResource - the target object on which the indexable resource applies.

conf - the indexable resource configuration

sid - optional Nuxeo Core session id. (XXX should be removed from the signature)

Returns:

a resolved indexable resource instance.

Throws:

IndexingException

createResolvedResourceFor

public ResolvedResource createResolvedResourceFor(java.io.Serializable targetResource,
                                                  IndexableResourceConf conf,
                                                  java.lang.String sid)
                                           throws IndexingException

Description copied from interface: IndexableResourceFactory

Resolves and returns an indexable resource instance.

Specified by:

createResolvedResourceFor in interface IndexableResourceFactory

Parameters:

targetResource - the target object on which the indexable resource applies.

conf - the indexable resource configuration

sid - optional Nuxeo Core session id. (XXX should be removed from the signature)

Returns:

a resolved indexable resource instance.

Throws:

IndexingException

createResolvedResourcesFor

public ResolvedResources createResolvedResourcesFor(java.io.Serializable targetResource,
                                                    IndexableResourceConf conf,
                                                    java.lang.String sid)
                                             throws IndexingException

Description copied from interface: IndexableResourceFactory

Resolves an indexable resources and returns an aggregated resolved resources instances.

The idea here is to simplify the generations of aggregated resources when only one indexable resource is involved.

Specified by:

createResolvedResourcesFor in interface IndexableResourceFactory

Parameters:

targetResource - the target object on which the indexable resource applies.

conf - the indexable resource configuration

sid - optional Nuxeo Core session id. (XXX should be removed from the signature)

Returns:

a resolved indexable resource instance.

Throws:

IndexingException