package org.springframework.data.marklogic.repository;

import com.marklogic.client.io.Format;
import org.springframework.data.annotation.QueryAnnotation;
import org.springframework.data.marklogic.repository.query.QueryType;
import org.springframework.data.marklogic.repository.query.SelectedMode;

import java.lang.annotation.*;

/**
 * Declare QBE queries directly on repository methods. This allows cleaner queries for more complex cases. This also
 * allows the "tweaking" of basic search parameters in a repository interface without having to use MarkLogicTemplate
 * directly to set them.
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
@Documented
@QueryAnnotation
public @interface Query {

    /**
     * Takes a MarkLogic QBE JSON string to define the actual query to be executed. This one will take precedence over the
     * method name then.
     *
     * @return
     */
    String value() default "";

    /**
     * Sometimes it is better to force the use of a range index for equality checks (to point to specific properties instead of
     * any property in a hierarchy).  This allows the ability to do so.  Changing to the RANGE type would require a range index
     * created, and possible the @Indexed attribute with the path set on the property in the POJO class.
     *
     * @return
     */
    QueryType type() default QueryType.VALUE;

    /**
     * The document format to match, either XML or JSON.  Currently can't match a mix using this approach, you would need
     * a StructuredQueryDefinition using the query builder in order to match both formats
     * @return
     */
    Format format() default Format.UNKNOWN;

    /**
     * Defines the properties that should be returned for the given query. Note that only these properties will make it into the
     * domain object returned.
     *
     * @return
     */
    String[] extract() default {};

    /**
     * Used in conjunction with the extract paths.  This determines how the extracted nodes are returned.  By default this
     * returns specified nodes in their original hierarchy, but you can also specify to just return the extracted nodes, or to
     * exclude the specified nodes.
     * @return
     */
    SelectedMode selected() default SelectedMode.HIERARCHICAL;

    /**
     * To specify any query options to use in the query.  Since the query could end up as a range query or a text query of some
     * kind, or MarkLogic could add additional options, this is not limited by an enumeration but the query will fail with
     * incorrect options.
     *
     * @return
     */
    String[] options() default {};

    /**
     * The name of a transform to use when returning/saving documents (depends on the type of operations that is annotated).
     * This transform must have been previously configured through the REST API otherwise the operation will fail.
     *
     * @return
     */
    String transform() default "";
}

@@ -2599,16 +2599,182 @@
 options.
+  These options are applied to all the value/range/text queries that are created, so if fine-%0A     * tuning is required at that level a custom Repository is required.
 %0A     *%0A

Add additional test cases for QBE