org.apache.solr.search
Class ReturnFields

java.lang.Object
  org.apache.solr.search.ReturnFields

Direct Known Subclasses:

SolrReturnFields

public abstract class ReturnFields
extends Object

A class representing the return fields

Since:

solr 4.0

Constructor Summary

ReturnFields()

Method Summary

abstract Set<String>	getLuceneFieldNames() Set of field names with their exact names from the lucene index.
abstract Set<String>	getRequestedFieldNames() The requested field names (includes pseudo fields)
abstract DocTransformer	getTransformer() Returns the DocTransformer used to modify documents, or null
abstract boolean	hasPatternMatching() Returns true if the fieldnames should be picked with a pattern
abstract boolean	wantsAllFields() Returns true if all fields should be returned.
abstract boolean	wantsField(String name) Returns true if the specified field should be returned.
abstract boolean	wantsScore() Returns true if the score should be returned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReturnFields

public ReturnFields()

Method Detail

getLuceneFieldNames

public abstract Set<String> getLuceneFieldNames()

Set of field names with their exact names from the lucene index.

Class such as ResponseWriters pass this to SolrIndexSearcher.doc(int, Set).

Returns:

Set of field names or null (all fields).

getRequestedFieldNames

public abstract Set<String> getRequestedFieldNames()

The requested field names (includes pseudo fields)

Returns:

Set of field names or null (all fields).

wantsField

public abstract boolean wantsField(String name)

Returns true if the specified field should be returned.

wantsAllFields

public abstract boolean wantsAllFields()

Returns true if all fields should be returned.

wantsScore

public abstract boolean wantsScore()

Returns true if the score should be returned.

hasPatternMatching

public abstract boolean hasPatternMatching()

Returns true if the fieldnames should be picked with a pattern

getTransformer

public abstract DocTransformer getTransformer()

Returns the DocTransformer used to modify documents, or null