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

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

All Implemented Interfaces:

Serializable, IndexableResource

Direct Known Subclasses:

AbstractNXCoreIndexableResource, AuditIndexableResourceImpl

public abstract class AbstractIndexableResource
extends Object
implements IndexableResource

Abstract indexable resource.

Author:

Julien Anguenot

See Also:

Serialized Form

Field Summary

protected IndexableResourceConf	configuration
protected String	name

Constructor Summary

protected	AbstractIndexableResource()
protected	AbstractIndexableResource(String name, IndexableResourceConf configuration)

Method Summary

ACP	computeAcp() Computes an ACP for the given resource.
IndexableResourceConf	getConfiguration() Returns this instance bound configuration.
String	getName() Returns the resource configuration name.
protected boolean	isBoundToIndexingThread()
protected void	login()
protected void	logout()

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.IndexableResource

computeId, getValueFor

Field Detail

name

protected String name

configuration

protected IndexableResourceConf configuration

Constructor Detail

AbstractIndexableResource

protected AbstractIndexableResource()

AbstractIndexableResource

protected AbstractIndexableResource(String name,
                                    IndexableResourceConf configuration)

Method Detail

getName

public String getName()

Description copied from interface: IndexableResource

Returns the resource configuration name.

Specified by:

getName in interface IndexableResource

Returns:

the resource name.

getConfiguration

public IndexableResourceConf getConfiguration()

Description copied from interface: IndexableResource

Returns this instance bound configuration.

Specified by:

getConfiguration in interface IndexableResource

Returns:

an IndexableResourceConf instance.

isBoundToIndexingThread

protected boolean isBoundToIndexingThread()

login

protected void login()

logout

protected void logout()

computeAcp

public ACP computeAcp()

Description copied from interface: IndexableResource

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.

Specified by:

computeAcp in interface IndexableResource

Returns:

null, which encourages the caller to continue investigating.