com.github.tennaito.rsql.misc.Mapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rsql-jpa Show documentation

A application used to translate RSQL nodes to JPA Criteria Query.

There is a newer version: 2.0.2

/*
 * The MIT License
 *
 * Copyright 2013 Jakub Jirutka .
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.github.tennaito.rsql.misc;

/**
 * Provides mapping of selectors in RSQL to property names of entities.
 *
 * @author Jakub Jirutka 
 */
public interface Mapper {

    /**
     * Translate given selector to the mapped property name or dot-separated
     * path of the property.
     *
     * @param selector Selector that identifies some element of an entry's content.
     * @param entityClass entity class
     * @return Property name or dot-separated path of the property.
     */
    String translate(String selector, Class entityClass);

}