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

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ResolvedResourcesImpl

public interface ResolvedResources
extends java.io.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.
java.util.List<ResolvedData>	getCommonIndexableData() Returns the indexable data that are common to all the indexable resources.
java.lang.String	getId() Returns a common key for all the resources.
ResolvedData	getIndexableDataByName(java.lang.String resourceName, java.lang.String name) Returns an indexable data given its name.
ResolvedResource	getIndexableResolvedResourceByConfName(java.lang.String name) Returns an indexable resolved resource given its configuration name.
java.util.List<ResolvedResource>	getIndexableResolvedResources() Returns the list of resolved resources.
java.util.List<ResolvedData>	getMergedIndexableData() Returns the list of all indexable data from all resolved resources.

Method Detail

getId

java.lang.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

java.util.List<ResolvedResource> getIndexableResolvedResources()

Returns the list of resolved resources.

Returns:

the list of resolved resources.

getMergedIndexableData

java.util.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

java.util.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(java.lang.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(java.lang.String resourceName,
                                    java.lang.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.