javax.jcr.query.qom.Ordering Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/*
 * Copyright 2009 Day Management AG, Switzerland. All rights reserved.
 */
package javax.jcr.query.qom;

/**
 * Determines the relative order of two node-tuples by evaluating {@link
 * #getOperand operand} for each.
 * 
 * For a first node-tuple, nt1, for which {@link #getOperand
 * operand} evaluates to v1, and a second node-tuple,
 * nt2, for which {@link #getOperand operand} evaluates to
 * v2: 
 If {@link #getOrder order} is
 * Ascending, then: if either v1 is null,
 * v2 is null, or both v1 and v2 are
 * null, the relative order of nt1 and nt2 is
 * implementation determined, otherwise
 if v1 is a
 * different property type than v2, the relative order of
 * nt1 and nt2 is implementation determined,
 * otherwise
 if v1 is ordered before v2, then
 * nt1 precedes nt2, otherwise
 if
 * v1 is ordered after v2, then nt2
 * precedes nt1, otherwise
 the relative order of
 * nt1 and nt2 is implementation determined and may be
 * arbitrary.
 Otherwise, if {@link #getOrder order} is
 * Descending, then: if either v1 is null,
 * v2 is null, or both v1 and v2 are
 * null, the relative order of nt1 and nt2 is
 * implementation determined, otherwise
 if v1 is a
 * different property type than v2, the relative order of
 * nt1 and nt2 is implementation determined,
 * otherwise
 if v1 is ordered before v2, then
 * nt2 precedes nt1, otherwise
 if
 * v1 is ordered after v2, then nt1
 * precedes nt2, otherwise
 the relative order of
 * nt1 and nt2 is implementation determined and may be
 * arbitrary.
 
 *
 * @since JCR 2.0
 */
public interface Ordering {
    /**
     * The operand by which to order.
     *
     * @return the operand; non-null
     */
    public DynamicOperand getOperand();

    /**
     * Gets the order.
     *
     * @return either  {@link QueryObjectModelConstants#JCR_ORDER_ASCENDING}
     *         or
 {@link QueryObjectModelConstants#JCR_ORDER_DESCENDING}
     *         
     */
    public String getOrder();
}