org.apache.solr.client.solrj.request.LukeRequest.java Source code

Introduction

Here is the source code for org.apache.solr.client.solrj.request.LukeRequest.java

Source

/*
 * 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.solr.client.solrj.request;

import java.util.ArrayList;
import java.util.List;

import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.SolrRequest;
import org.apache.solr.client.solrj.response.LukeResponse;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.common.params.ModifiableSolrParams;
import org.apache.solr.common.params.SolrParams;

/**
 * 
 *
 * @since solr 1.3
 */
public class LukeRequest extends SolrRequest<LukeResponse> {

    private List<String> fields;
    private int numTerms = -1;
    private boolean showSchema = false;
    private Boolean includeIndexFieldFlags = null;

    public LukeRequest() {
        super(METHOD.GET, "/admin/luke");
    }

    public LukeRequest(String path) {
        super(METHOD.GET, path);
    }

    //---------------------------------------------------------------------------------
    //---------------------------------------------------------------------------------

    public void addField(String f) {
        if (fields == null) {
            fields = new ArrayList<>();
        }
        fields.add(f);
    }

    public void setFields(List<String> f) {
        fields = f;
    }

    //---------------------------------------------------------------------------------
    //---------------------------------------------------------------------------------

    public boolean isShowSchema() {
        return showSchema;
    }

    public void setShowSchema(boolean showSchema) {
        this.showSchema = showSchema;
    }

    public int getNumTerms() {
        return numTerms;
    }

    /**
     * the number of terms to return for a given field.  If the number is 0, it will not traverse the terms.  
     */
    public void setNumTerms(int count) {
        this.numTerms = count;
    }

    //---------------------------------------------------------------------------------
    //---------------------------------------------------------------------------------

    /**
     * Choose whether /luke should return the index-flags for each field
     *
     * Fetching and returning the index-flags for each field in your index has non-zero cost, and can slow down requests to
     * /luke.  Users who do not care about these values can tell Solr to avoid generating them by setting the
     * 'includeIndexFieldFlags' flag to false, saving their requests some processing.
     */
    public void setIncludeIndexFieldFlags(boolean shouldInclude) {
        includeIndexFieldFlags = shouldInclude;
    }

    public boolean getIncludeIndexFieldFlags() {
        return includeIndexFieldFlags;
    }

    //---------------------------------------------------------------------------------
    //---------------------------------------------------------------------------------

    @Override
    protected LukeResponse createResponse(SolrClient client) {
        return new LukeResponse();
    }

    @Override
    public SolrParams getParams() {
        ModifiableSolrParams params = new ModifiableSolrParams();
        if (fields != null && fields.size() > 0) {
            params.add(CommonParams.FL, fields.toArray(new String[fields.size()]));
        }
        if (numTerms >= 0) {
            params.add("numTerms", numTerms + "");
        }
        if (showSchema) {
            params.add("show", "schema");
        }
        if (includeIndexFieldFlags != null) {
            params.add("includeIndexFieldFlags", includeIndexFieldFlags.toString());
        }

        return params;
    }

}