org.nuxeo.ecm.platform.audit.search.resources.indexing
Class AuditIndexableResourceFactory

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

All Implemented Interfaces:

Serializable, IndexableResourceFactory

public class AuditIndexableResourceFactory
extends AbstractIndexableResourceFactory
implements IndexableResourceFactory

Audit indexable resource factory.

Author:

Julien Anguenot

See Also:

Serialized Form

Constructor Summary

AuditIndexableResourceFactory()

Method Summary

IndexableResource	createEmptyIndexableResource() Returns an empty indexable resource instance.
IndexableResource	createIndexableResourceFrom(Serializable targetResourceId, IndexableResourceConf conf, String sid) Returns an indexable resource instance given a target object needed by the resource along with its configuration.
ResolvedResource	resolveResourceFor(IndexableResource resource) Resolves an indexable resource instance.
ResolvedResources	resolveResourcesFor(IndexableResource resource) Resolves an indexable resources and returns an aggregated resolved resources instances.

Methods inherited from class org.nuxeo.ecm.core.search.api.client.indexing.resources.AbstractIndexableResourceFactory

createResolvedResourceFor, createResolvedResourcesFor, resolveResourceFor

Methods inherited from class java.lang.Object

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

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

createResolvedResourceFor, createResolvedResourcesFor, resolveResourceFor

Constructor Detail

AuditIndexableResourceFactory

public AuditIndexableResourceFactory()

Method Detail

createEmptyIndexableResource

public IndexableResource createEmptyIndexableResource()

Description copied from interface: IndexableResourceFactory

Returns an empty indexable resource instance.

Useful for complete computations of indexable resources outside of the factory.

Specified by:

createEmptyIndexableResource in interface IndexableResourceFactory

Returns:

an empty indexable resource instance.

createIndexableResourceFrom

public IndexableResource createIndexableResourceFrom(Serializable targetResourceId,
                                                     IndexableResourceConf conf,
                                                     String sid)
                                              throws IndexingException

Description copied from interface: IndexableResourceFactory

Returns an indexable resource instance given a target object needed by the resource along with its configuration.

For instance it could be a document model or log entry id or still a relation.

Specified by:

createIndexableResourceFrom in interface IndexableResourceFactory

Parameters:

targetResourceId - : the target object on which the indexable resource applies.

conf - : the bound indexable resource configuration.

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

Returns:

an indexable resource instance.

Throws:

IndexingException

resolveResourceFor

public ResolvedResource resolveResourceFor(IndexableResource resource)
                                    throws IndexingException

Description copied from interface: IndexableResourceFactory

Resolves an indexable resource instance.

Note the indexable resource instance contains the configuration and the target object on which it applies.

Specified by:

resolveResourceFor in interface IndexableResourceFactory

Parameters:

resource - : the indexable resource instance.

Returns:

a resolved indexable resource instance.

Throws:

IndexingException

resolveResourcesFor

public ResolvedResources resolveResourcesFor(IndexableResource resource)
                                      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:

resolveResourcesFor in interface IndexableResourceFactory

Parameters:

resource - : an indexable resource instance.

Returns:

a resolved indexable resource instance.

Throws:

IndexingException