org.nuxeo.ecm.core.search.api.client.indexing.resources
Interface IndexableResource

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

AuditIndexableResource, DocumentBuiltinsIndexableResource, DocumentIndexableResource, NXCoreIndexableResource

All Known Implementing Classes:

AbstractIndexableResource, AbstractNXCoreIndexableResource, AuditIndexableResourceImpl, DocumentBuiltinsIndexableResourceImpl, DocumentIndexableResourceImpl, FakeIndexableResource

public interface IndexableResource
extends java.io.Serializable

Base interface for indexable resources.

An indexable resource is a data source where to get data to index. For instance, a Nuxeo core document is an example of resource. SQL, JPA, Hibernate resources are as candidates.

An indexable resource contains a set of indexable data.

Author:

Julien Anguenot

Method Summary

ACP	computeAcp() Computes an ACP for the given resource.
java.lang.String	computeId() Computes the resource unique id.
IndexableResourceConf	getConfiguration() Returns this instance bound configuration.
java.lang.String	getName() Returns the resource configuration name.
java.io.Serializable	getValueFor(java.lang.String indexableDataName) Returns the value for a given indexable data name.

Method Detail

getName

java.lang.String getName()

Returns the resource configuration name.

Returns:

the resource name.

computeId

java.lang.String computeId()

Computes the resource unique id. This can be costly, since it may involve fetching data, computing hash codes, etc.

Returns:

the resource id

getConfiguration

IndexableResourceConf getConfiguration()

Returns this instance bound configuration.

Returns:

an IndexableResourceConf instance.

getValueFor

java.io.Serializable getValueFor(java.lang.String indexableDataName)
                                 throws IndexingException

Returns the value for a given indexable data name.

Parameters:

indexableDataName - the actual indexable data name resource side.

Returns:

a serializable object holding the value.

Throws:

IndexingException - TODO

computeAcp

ACP computeAcp()

Computes an ACP for the given resource.

The returned value applies to all the resources that may be associated with the present one in an IndexableResources. Confidence in the validity of said value must be as strong as it gets. The counterpart is that the caller must interpret null return values as a lack of info from this and perform other computations.

Returns:

the ACP