org.jboss.pnc.facade.rsql.RSQLProducer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of facade Show documentation
Common module for front-facing implementations like REST.
There is a newer version: 3.0.4
/**
 * JBoss, Home of Professional Open Source.
 * Copyright 2014-2022 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jboss.pnc.facade.rsql;

import org.jboss.pnc.facade.rsql.mapper.RSQLMapper;
import org.jboss.pnc.model.GenericEntity;
import org.jboss.pnc.spi.datastore.repositories.api.Predicate;
import org.jboss.pnc.spi.datastore.repositories.api.SortInfo;

import java.util.Comparator;

/**
 *
 * @author Honza Brázdil <[email protected]>
 */
public interface RSQLProducer {

    /**
     * See {@link this#getCriteriaPredicate(RSQLMapper, String)}. However, the RSQL mapper is automatically selected
     * using the given type.
     *
     * @param  Type of the entity.
     * @param type Entity type.
     * @param rsql The query RSQL.
     * @return Predicate representing the RSQL query.
     */
    > Predicate getCriteriaPredicate(Class type, String rsql);

    /**
     * Creates a Criteria API predicate from RSQL query for DB search. It uses provided mapper to map RSQL selector to
     * Criteria API path. The predicate can throw a runtime exception when used if the query is bad.
     *
     * @param  Type of the entity.
     * @param mapper RSQL mapper to be used.
     * @param rsql The query RSQL.
     */
    > Predicate getCriteriaPredicate(RSQLMapper mapper, String rsql);

    /**
     * Creates a predicate from RSQL query for stream search. The predicate can throw a runtime exception when used if
     * the query is bad.
     * 
     * @param  Type of the entity.
     * @param rsql The query RSQL.
     * @return Predicate representing the RSQL query.
     */
     java.util.function.Predicate getStreamPredicate(String rsql);

    /**
     * See {@link this#getSortInfo(RSQLMapper, String)}. However, the RSQL mapper is automatically selected using the
     * given type.
     *
     * @param  Type of the entity.
     * @param type Entity type.
     * @param rsql query for sorting, e.g. "=asc=id".
     * @return Sort Info object.
     */
    > SortInfo getSortInfo(Class type, String rsql);

    /**
     * Creates a {@link SortInfo} from RSQL query for DB search. It uses provided mapper to map RSQL selector to
     * Criteria API path.
     *
     * @param  Type of the entity.
     * @param mapper RSQL mapper to be used.
     * @param rsql query for sorting, e.g. "=asc=id".
     */
    > SortInfo getSortInfo(RSQLMapper mapper, String rsql);

    /**
     * Gets comparator based on RSQL query.
     *
     * @param  Type of the entity.
     * @param rsql query for sorting, e.g. "=asc=id".
     * @return Comparator baset of the RSQL query.
     * @throws IllegalArgumentException when the rsql query is null or empty.
     */
     Comparator getComparator(String rsql);
}