com.liferay.adaptive.media.image.finder

Interface AMImageQueryBuilder.FuzzySortStep

All Superinterfaces:

AMImageQueryBuilder.FinalStep

All Known Subinterfaces:

AMImageQueryBuilder.InitialStep

Enclosing interface:

AMImageQueryBuilder

public static interface AMImageQueryBuilder.FuzzySortStep
extends AMImageQueryBuilder.FinalStep

Method Summary

Modifier and Type	Method and Description
<V> AMImageQueryBuilder.FuzzySortStep	with(AMAttribute<AMImageProcessor,V> amAttribute, java.util.Optional<V> valueOptional) An intermediate method that sorts the adaptive media based on specific attribute values.
<V> AMImageQueryBuilder.FuzzySortStep	with(AMAttribute<AMImageProcessor,V> amAttribute, V value) An intermediate method that sorts the adaptive media based on specific attribute values.

Methods inherited from interface com.liferay.adaptive.media.image.finder.AMImageQueryBuilder.FinalStep

done

Method Detail

with

<V> AMImageQueryBuilder.FuzzySortStep with(AMAttribute<AMImageProcessor,V> amAttribute,
                                           java.util.Optional<V> valueOptional)

An intermediate method that sorts the adaptive media based on specific attribute values. Sorting is done using a distance comparator that returns the adaptive media images that are a closer match first.

The distance comparator is implemented based on the value returned by the method AMAttribute.distance(Object, Object).

If the method AMImageQueryBuilder.StrictSortStep.orderBy(com.liferay.adaptive.media.AMAttribute<com.liferay.adaptive.media.image.processor.AMImageProcessor, V>, com.liferay.adaptive.media.image.finder.AMImageQueryBuilder.SortOrder) is invoked in the same query builder, it takes precedence and this method has no effect.

If this method is invoked with multiple attributes, they will be used in the following order:

1. The first attribute sorts all the adaptive media images.
2. If two or more adaptive media images are located at the same distance, the second attribute is used to sort those elements.
3. If the second attribute doesn't resolve all the cases, the third attribute is used, and so on.

Parameters:

amAttribute - the attribute used to sort the adaptive media images

valueOptional - a non-null optional value for the attribute

with

<V> AMImageQueryBuilder.FuzzySortStep with(AMAttribute<AMImageProcessor,V> amAttribute,
                                           V value)

An intermediate method that sorts the adaptive media based on specific attribute values. Sorting is done using a distance comparator that returns the adaptive media images that are a closer match first.

The distance comparator is implemented based on the value returned by the method AMAttribute.distance(Object, Object).

If the method AMImageQueryBuilder.StrictSortStep.orderBy(com.liferay.adaptive.media.AMAttribute<com.liferay.adaptive.media.image.processor.AMImageProcessor, V>, com.liferay.adaptive.media.image.finder.AMImageQueryBuilder.SortOrder) is invoked in the same query builder, it takes precedence and this method has no effect.

If this method is invoked with multiple attributes, they will be used in the following order:

1. The first attribute sorts all the adaptive media images.
2. If two or more adaptive media images are located at the same distance, the second attribute is used to sort those elements.
3. If the second attribute doesn't resolve all the cases, the third attribute is used, and so on.

Parameters:

amAttribute - the attribute used to sort the adaptive media images

value - the attribute's value