javax.jcr.query.qom.FullTextSearch 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;

/**
 * Performs a full-text search.
 * 
 * The full-text search expression is evaluated against the set of full-text
 * indexed properties within the full-text search scope.  If {@link
 * #getPropertyName property} is specified, the full-text search scope is the
 * property of that name on the {@link #getSelectorName selector} node in the
 * node-tuple; otherwise the full-text search scope is all properties of the
 * {@link #getSelectorName selector} node (or, in some implementations, all
 * properties in the node subgraph).
 * 

 * Which properties (if any) in a repository are full-text indexed is
 * implementation determined.
 * 

 * It is also implementation determined whether {@link #getFullTextSearchExpression
 * fullTextSearchExpression} is independently evaluated against each full-text
 * indexed property in the full-text search scope, or collectively evaluated
 * against the set of such properties using some implementation-determined
 * mechanism.
 * 

 * Similarly, for multi-valued properties, it is implementation determined
 * whether {@link #getFullTextSearchExpression fullTextSearchExpression} is
 * independently evaluated against each element in the array of values, or
 * collectively evaluated against the array of values using some
 * implementation-determined mechanism.
 * 

 * At minimum, an implementation must support the following {@link
 * #getFullTextSearchExpression fullTextSearchExpression} grammar:
 * 
  fullTextSearchExpression ::= [-]term {whitespace [OR] whitespace
 * [-]term}
 * 
 *  term ::= word | '"' word {whitespace word} '"'
 * 

 *  word ::= (A string containing no whitespace)
 * 

 *  whitespace ::= (A string of only whitespace)
 * 
 * 
 * A query satisfies a FullTextSearch constraint if the value (or
 * values) of the full-text indexed properties within the full-text search scope
 * satisfy the specified {@link #getFullTextSearchExpression
 * fullTextSearchExpression}, evaluated as follows: 
 A term not preceded
 * with "-" (minus sign) is satisfied only if the value contains
 * that term.
 A term preceded with "-" (minus sign) is
 * satisfied only if the value does not contain that term.
 Terms
 * separated by whitespace are implicitly "ANDed".
 Terms separated by
 * "OR" are "ORed".
 "AND" has higher precedence than "OR".
 * 
Within a term, each double quote ("), "-"
 * (minus sign), and "\" (backslash) must be escaped by a preceding
 * "\" (backslash).
 
 *
 * @since JCR 2.0
 */
public interface FullTextSearch
        extends Constraint {
    /**
     * Gets the name of the selector against which to apply this constraint.
     *
     * @return the selector name; non-null
     */
    public String getSelectorName();

    /**
     * Gets the name of the property.
     *
     * @return the property name if the full-text search scope is a property,
     *         otherwise null if the full-text search scope is the node (or node
     *         subgraph, in some implementations).
     */
    public String getPropertyName();

    /**
     * Gets the full-text search expression.
     *
     * @return the full-text search expression; non-null
     */
    public StaticOperand getFullTextSearchExpression();
}