org.nuxeo.ecm.core.search.api.backend.indexing.resources
Interface ResolvedResources

All Superinterfaces:

Serializable

All Known Implementing Classes:

ResolvedResourcesImpl

public interface ResolvedResources
extends Serializable

Resolved resources are for one step related resources indexing.

Author:

Julien Anguenot

Method Summary

ACP	getACP() Returns the ACP to apply on the whole resources.
List<ResolvedData>	getCommonIndexableData() Returns the indexable data that are common to all the indexable resources.
String	getId() Returns a common key for all the resources.
ResolvedData	getIndexableDataByName(String resourceName, String name) Returns an indexable data given its name.
ResolvedResource	getIndexableResolvedResourceByConfName(String name) Returns an indexable resolved resource given its configuration name.
List<ResolvedResource>	getIndexableResolvedResources() Returns the list of resolved resources.
List<ResolvedData>	getMergedIndexableData() Returns the list of all indexable data from all resolved resources.

Method Detail

getId

String getId()

Returns a common key for all the resources. The common key is intended to be used for join type queries.

Returns:

a common key for all the resources.

getIndexableResolvedResources

List<ResolvedResource> getIndexableResolvedResources()

Returns the list of resolved resources.

Returns:

the list of resolved resources.

getMergedIndexableData

List<ResolvedData> getMergedIndexableData()

Returns the list of all indexable data from all resolved resources.

Returns:

the list of all indexable data from all resolved resources.

getCommonIndexableData

List<ResolvedData> getCommonIndexableData()

Returns the indexable data that are common to all the indexable resources.

Returns:

a list if indexable data.

getACP

ACP getACP()

Returns the ACP to apply on the whole resources.

Will be useful for the backend to compute its security index.

Returns:

an Nuxeo core ACP object.

getIndexableResolvedResourceByConfName

ResolvedResource getIndexableResolvedResourceByConfName(String name)

Returns an indexable resolved resource given its configuration name.

Parameters:

name - : the name of the resource.

Returns:

an ResolvedResource instance if exists null if not.

getIndexableDataByName

ResolvedData getIndexableDataByName(String resourceName,
                                    String name)

Returns an indexable data given its name.

Parameters:

name - : the name of the indexable data

resourceName - : the name of the resource which is supposed to hold the indexable data

Returns:

an ResolvedData instance if exists null if not.