/*
 * Copyright Â© 2013-2014 The Hyve B.V.
 *
 * This file is part of transmart-core-db.
 *
 * Transmart-core-db is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * transmart-core-db.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.transmartproject.db.dataquery.highdim.parameterproducers

import java.lang.annotation.ElementType
import java.lang.annotation.Retention
import java.lang.annotation.RetentionPolicy
import java.lang.annotation.Target

/**
 * Annotation to apply to methods of {@link org.transmartproject.db.dataquery.highdim.parameterproducers.DataRetrievalParameterFactory}
 * subtypes, for indicating the name of the constraint or projection that
 * that method handles.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target([ ElementType.METHOD ])
@interface ProducerFor {

    /**
     * The name of the constraint or projection name targeted by the annotated
     * method.
     * @return a constraint/projection name
     */
    String value()
}
