senselogic.sitevision.api.search.index

Interface IndexingUtil

All Superinterfaces:

VelocityAccess.IndexingUtilConstants

@Requireable(value="IndexingUtil")
public interface IndexingUtil
extends VelocityAccess.IndexingUtilConstants

Indexing utility interface.

An instance of the Sitevision class implementing this interface can be obtained via SearchFactory.getIndexingUtil(). See SearchFactory for how to obtain an instance of the SearchFactory interface.

Since:

Sitevision 3.6.4

Author:

Magnus Lövgren

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RESOURCE_PRIORITY The default resource priority.
static int	MAX_RESOURCE_PRIORITY The maximum resource priority.
static int	MIN_RESOURCE_PRIORITY The minimum resource priority.

Method Summary

Modifier and Type	Method and Description
boolean	setResourcePriority(Node aNode, int aPriority) Sets the resource priority for an indexable node.

Methods inherited from interface senselogic.sitevision.api.render.velocity.VelocityAccess.IndexingUtilConstants

getDEFAULT_RESOURCE_PRIORITY, getMAX_RESOURCE_PRIORITY, getMIN_RESOURCE_PRIORITY

Field Detail

MIN_RESOURCE_PRIORITY

static final int MIN_RESOURCE_PRIORITY

The minimum resource priority. A resource indexed with this priority value will get a document boost of 0.1F.

See Also:

Constant Field Values

DEFAULT_RESOURCE_PRIORITY

static final int DEFAULT_RESOURCE_PRIORITY

The default resource priority. A resource indexed with this priority value will get the default document boost of 1.0F.

See Also:

Constant Field Values

MAX_RESOURCE_PRIORITY

static final int MAX_RESOURCE_PRIORITY

The maximum resource priority. A resource indexed with this priority value will get a document boost of 2.0F.

See Also:

Constant Field Values

Method Detail

setResourcePriority

boolean setResourcePriority(Node aNode,
                            int aPriority)

Sets the resource priority for an indexable node.

The resource priority of a node will influence its document boost when indexed.

Note! Method invocations that doesn't fulfill these 3 criteria will always fail (i.e. return false):

• The aNode must be an indexable node, typically a sv:page, sv:article, sv:file or sv:image.
• The aPriority must be in interval: [ MIN_RESOURCE_PRIORITY .. MAX_RESOURCE_PRIORITY ].
• Current user must have PermissionUtil.Permission.WRITE and PermissionUtil.Permission.MODIFY_SEARCH_PRIORITY on aNode.

This method tries to acquire a lock on aNode in order to mutate its resource priority. Mutation will fail (i.e. this method will return false) if aNode is already locked.

Indexing note! Changing the value of the resource priority of a node will automatically trigger a re-index of the node.

Parameters:

aNode - the indexable node

aPriority - the priority, i.e. in interval: [ MIN_RESOURCE_PRIORITY .. MAX_RESOURCE_PRIORITY ]

Returns:

true if the operation succeeded, false otherwise