All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.cxf.jaxrs.ext.search.SearchContextImpl Maven / Gradle / Ivy

There is a newer version: 3.0.0-milestone2
Show newest version
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.cxf.jaxrs.ext.search;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Logger;

import javax.ws.rs.core.MultivaluedMap;

import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.helpers.CastUtils;
import org.apache.cxf.jaxrs.ext.search.client.CompleteCondition;
import org.apache.cxf.jaxrs.ext.search.client.SearchConditionBuilder;
import org.apache.cxf.jaxrs.ext.search.fiql.FiqlParser;
import org.apache.cxf.jaxrs.utils.InjectionUtils;
import org.apache.cxf.jaxrs.utils.JAXRSUtils;
import org.apache.cxf.message.Message;
import org.apache.cxf.message.MessageUtils;

public class SearchContextImpl implements SearchContext {

    public static final String SEARCH_QUERY = "_search";
    public static final String SHORT_SEARCH_QUERY = "_s";
    public static final String CUSTOM_SEARCH_QUERY_PARAM_NAME = "search.query.parameter.name";
    private static final String USE_PLAIN_QUERY_PARAMETERS = "search.use.plain.queries";
    private static final String USE_ALL_QUERY_COMPONENT = "search.use.all.query.component";
    private static final Logger LOG = LogUtils.getL7dLogger(SearchContextImpl.class);
    private Message message;
    
    public SearchContextImpl(Message message) {
        this.message = message;
    }
    
    public  SearchCondition getCondition(Class cls) {
        return getCondition(null, cls);
    }
    
    public  SearchCondition getCondition(Class cls, Map beanProperties) {
        return getCondition(null, cls, beanProperties);
    }
    
    public  SearchCondition getCondition(Class cls, 
                                               Map beanProperties,
                                               Map parserProperties) {
        return getCondition(null, cls, beanProperties, parserProperties);
    }
    
    public  SearchCondition getCondition(String expression, Class cls) {
        return getCondition(expression, cls, null);
    }
    
    public  SearchCondition getCondition(String expression, 
                                               Class cls, 
                                               Map beanProperties) {
        return getCondition(expression, cls, beanProperties, null);
    }
    
    public  SearchCondition getCondition(String expression, 
                                               Class cls, 
                                               Map beanProperties,
                                               Map parserProperties) {    
        if (InjectionUtils.isPrimitive(cls)) {
            String errorMessage = "Primitive condition types are not supported"; 
            LOG.warning(errorMessage);
            throw new IllegalArgumentException(errorMessage);
        }
        
        SearchConditionParser parser = getParser(cls, beanProperties, parserProperties);
        
        String theExpression = expression == null 
            ? getSearchExpression() : expression;
        if (theExpression != null) {
            try {
                return parser.parse(theExpression);
            } catch (SearchParseException ex) {
                return null;
            }
        } else {
            return null;
        }
        
    }

    public String getSearchExpression() {
        
        String queryStr = (String)message.get(Message.QUERY_STRING);
        if (queryStr != null) { 
            if (MessageUtils.isTrue(message.getContextualProperty(USE_ALL_QUERY_COMPONENT))) {
                return queryStr;
            }
            MultivaluedMap params = 
                JAXRSUtils.getStructuredParams(queryStr, "&", true, false);
            String customQueryParamName = (String)message.getContextualProperty(CUSTOM_SEARCH_QUERY_PARAM_NAME);
            if (customQueryParamName != null) {
                return params.getFirst(customQueryParamName);
            }
            if (queryStr.contains(SHORT_SEARCH_QUERY) || queryStr.contains(SEARCH_QUERY)) {
                if (params.containsKey(SHORT_SEARCH_QUERY)) {
                    return params.getFirst(SHORT_SEARCH_QUERY);
                } else {
                    return params.getFirst(SEARCH_QUERY);
                }
            } else if (MessageUtils.isTrue(message.getContextualProperty(USE_PLAIN_QUERY_PARAMETERS))) {
                return convertPlainQueriesToFiqlExp(params);     
            }
        }
        return null;
        
    }
    
    private String convertPlainQueriesToFiqlExp(MultivaluedMap params) {
        SearchConditionBuilder builder = SearchConditionBuilder.instance();
        List list = new ArrayList(params.size());
        
        for (Map.Entry> entry : params.entrySet()) {
            list.add(getOrCondition(builder, entry));
        }
        return builder.and(list).query();
    }
    
    private CompleteCondition getOrCondition(SearchConditionBuilder builder,
                                             Map.Entry> entry) {
        String key = entry.getKey();
        ConditionType ct = null;
        if (key.endsWith("From")) { 
            ct = ConditionType.GREATER_OR_EQUALS;
            key = key.substring(0, key.length() - 4);
        } else if (key.endsWith("Till")) {
            ct = ConditionType.LESS_OR_EQUALS;
            key = key.substring(0, key.length() - 4);
        } else {
            ct = ConditionType.EQUALS;
        }
        
        List list = new ArrayList(entry.getValue().size());
        for (String value : entry.getValue()) {
            list.add(builder.is(key).comparesTo(ct, value));
        }
        return builder.or(list);
    }
    
    
    
    private  SearchConditionParser getParser(Class cls, 
                                                   Map beanProperties,
                                                   Map parserProperties) {
        // we can use this method as a parser factory, ex
        // we can get parsers capable of parsing XQuery and other languages
        // depending on the properties set by a user
        Map props = null;
        if (parserProperties == null) {
            props = new LinkedHashMap(4);
            props.put(SearchUtils.DATE_FORMAT_PROPERTY, 
                      (String)message.getContextualProperty(SearchUtils.DATE_FORMAT_PROPERTY));
            props.put(SearchUtils.TIMEZONE_SUPPORT_PROPERTY, 
                      (String)message.getContextualProperty(SearchUtils.TIMEZONE_SUPPORT_PROPERTY));
            props.put(SearchUtils.LAX_PROPERTY_MATCH, 
                      (String)message.getContextualProperty(SearchUtils.LAX_PROPERTY_MATCH));
            // FIQL specific
            props.put(FiqlParser.SUPPORT_SINGLE_EQUALS, 
                      (String)message.getContextualProperty(FiqlParser.SUPPORT_SINGLE_EQUALS)); 
        } else {
            props = parserProperties;
        }
        
        Map beanProps = null;
            
        if (beanProperties == null) {    
            beanProps = CastUtils.cast((Map)message.getContextualProperty(SearchUtils.BEAN_PROPERTY_MAP));
        } else {
            beanProps = beanProperties;
        }
        
        return new FiqlParser(cls, props, beanProps); 
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy