org.apache.solr.search.ReturnFields Maven / Gradle / Ivy
/*
* 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.search;
import java.util.*;
import org.apache.solr.response.transform.DocTransformer;
/**
* A class representing the return fields
*
*
* @since solr 4.0
*/
public abstract class ReturnFields {
/**
* Set of field names with their exact names from the lucene index.
*
* Class such as ResponseWriters pass this to {@link SolrIndexSearcher#doc(int, Set)}.
* @return Set of field names or null (all fields).
*/
public abstract Set getLuceneFieldNames();
/**
* The requested field names (includes pseudo fields)
*
* @return Set of field names or null (all fields).
*/
public abstract Set getRequestedFieldNames();
/** Returns true if the specified field should be returned. */
public abstract boolean wantsField(String name);
/** Returns true if all fields should be returned. */
public abstract boolean wantsAllFields();
/** Returns true if the score should be returned. */
public abstract boolean wantsScore();
/** Returns true if the fieldnames should be picked with a pattern */
public abstract boolean hasPatternMatching();
/** Returns the DocTransformer used to modify documents, or null */
public abstract DocTransformer getTransformer();
}