Package org.hibernate.search.mapper.pojo.model.path.spi

Interface PojoPathFilter

public interface PojoPathFilter

Defines a set of paths that are of importance, so that they can be detected at runtime when given a set of paths.

Used in particular in dirty checking, see PojoImplicitReindexingResolver.

Method Summary

Modifier and Type	Method	Description
BitSet	all()
BitSet	filter(int pathOrdinal)	For the given path ordinal, sets the corresponding ordinal in a bitset if the path is accepted by the filter, and return that bitset or null if the path is not relevant.
BitSet	filter(int[] pathOrdinals)	For each path ordinal in the given array, sets the corresponding ordinal in a bitset if the path is accepted by the filter, and return that bitset or null if none of the paths are relevant.
BitSet	filter(String path)	Sets the ordinal corresponding to the given path in a bitset if the path is accepted by the filter, and return that bitset or null if the path is not accepted by the filter.
BitSet	filter(String... paths)	For each path in the given array, sets the corresponding ordinal in a bitset if the path is accepted by the filter, and return that bitset or null if none of the paths are relevant.
boolean	test(BitSet pathSelection)	Determines if any path in the given set of paths of is accepted by this filter.

Method Detail

test

boolean test(BitSet pathSelection)

Determines if any path in the given set of paths of is accepted by this filter.

This method is optimized to be called very often.

Parameters:

pathSelection - A BitSet representing a set of paths using the path ordinals. Never null.

Returns:

true if any path in the given set is accepted by this filter, false otherwise.

filter

BitSet filter(String path)

Sets the ordinal corresponding to the given path in a bitset if the path is accepted by the filter, and return that bitset or null if the path is not accepted by the filter.

Parameters:

path - The string representations of a path. Never null.

Returns:

A BitSet whose only set bit is the ordinal of the given path if the path is accepted by this filter, or null if the path is not accepted by this filter.

filter

BitSet filter(String... paths)

For each path in the given array, sets the corresponding ordinal in a bitset if the path is accepted by the filter, and return that bitset or null if none of the paths are relevant.

Parameters:

paths - A array of string representations of paths. Never null.

Returns:

A BitSet representing all paths that are included in paths and are accepted by this filter. null if none of the paths is accepted by this filter.

filter

BitSet filter(int[] pathOrdinals)

For each path ordinal in the given array, sets the corresponding ordinal in a bitset if the path is accepted by the filter, and return that bitset or null if none of the paths are relevant.

Parameters:

pathOrdinals - A array of path ordinals. Never null.

Returns:

A BitSet representing all paths that are included in paths and are accepted by this filter. null if none of the paths is accepted by this filter.

filter

BitSet filter(int pathOrdinal)

For the given path ordinal, sets the corresponding ordinal in a bitset if the path is accepted by the filter, and return that bitset or null if the path is not relevant.

Parameters:

pathOrdinal - A path ordinal.

Returns:

A BitSet representing the single given path if it is accepted by this filter, or null if it is not.

all

BitSet all()

Returns:

A BitSet representing all paths that are accepted by this filter, or null if there is none.