public abstract class ReturnFields extends Object
Constructor and Description |
---|
ReturnFields() |
Modifier and Type | Method and Description |
---|---|
abstract Map<String,String> |
getFieldRenames()
Get the fields which have been renamed
|
abstract Set<String> |
getLuceneFieldNames()
Set of field names with their exact names from the lucene index.
|
abstract Set<String> |
getLuceneFieldNames(boolean ignoreWantsAll)
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 to the external client. |
abstract boolean |
wantsField(String name)
Returns
true if the specified field should be returned to the external client
-- either using its own name, or via an alias. |
abstract boolean |
wantsScore()
Returns
true if the score should be returned. |
public abstract Set<String> getLuceneFieldNames()
SolrIndexSearcher.doc(int, Set)
.
NOTE: In some situations, this method may return null
even if wantsAllFields()
is false
. For example: When glob expressions are used (hasPatternMatching()
),
it is safer to request all field names then to attempt to resolve the globs against all possible
dynamic field names in the index.
null
(all fields).public abstract Set<String> getLuceneFieldNames(boolean ignoreWantsAll)
ignoreWantsAll
- If true, it returns any additional specified field names, in spite of
also wanting all fields. Example: when fl=*,field1, returns ["field1"].
If false, the method returns null when all fields are wanted. Example: when fl=*,field1, returns null.
Note that this method returns null regardless of ignoreWantsAll if all fields
are requested and no explicit field names are specified.public abstract Set<String> getRequestedFieldNames()
null
(all fields).public abstract Map<String,String> getFieldRenames()
public abstract boolean wantsField(String name)
true
if the specified field should be returned to the external client
-- either using its own name, or via an alias.
This method returns false
even if the specified name is needed as an "extra" field
for use by transformers.public abstract boolean wantsAllFields()
true
if all fields should be returned to the external client.public abstract boolean wantsScore()
true
if the score should be returned.public abstract boolean hasPatternMatching()
true
if the fieldnames should be picked with a patternpublic abstract DocTransformer getTransformer()
null
Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.