BaseEditorialTransformer (Solr 9.1.1 core API)

java.lang.Object
- org.apache.solr.response.transform.DocTransformer
- - org.apache.solr.response.transform.BaseEditorialTransformer

public abstract class BaseEditorialTransformer
extends DocTransformer

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.solr.response.transform.DocTransformer
  DocTransformer.NoopFieldTransformer

Field Summary
- Fields inherited from class org.apache.solr.response.transform.DocTransformer
  context

Constructor Summary

Constructors
Constructor Description

BaseEditorialTransformer(String name, String idFieldName, FieldType ft)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract Set<org.apache.lucene.util.BytesRef>`	`getIdSet()`
`protected org.apache.lucene.util.BytesRef`	`getKey(org.apache.solr.common.SolrDocument doc)`
`String`	`getName()`
`void`	`transform(org.apache.solr.common.SolrDocument doc, int docid)`	This is where implementations do the actual work.

Methods inherited from class org.apache.solr.response.transform.DocTransformer
getExtraRequestFields, getRawFields, needsSolrIndexSearcher, setContext, toString, transform

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BaseEditorialTransformer
```
public BaseEditorialTransformer(String name,
                                String idFieldName,
                                FieldType ft)
```
- Method Detail
  - getName
```
public String getName()
```
    Specified by:
    
    getName in class DocTransformer
    
    Returns:
    
    The name of the transformer
  - transform
```
public void transform(org.apache.solr.common.SolrDocument doc,
                      int docid)
```
    Description copied from class: DocTransformer
    
    This is where implementations do the actual work. If implementations require a valid docId and index access, the DocTransformer.needsSolrIndexSearcher() method must return true
    
    Specified by:
    
    transform in class DocTransformer
    
    Parameters:
    
    doc - The document to alter
    
    docid - The Lucene internal doc id, or -1 in cases where the doc did not come from the index
    
    See Also:
    
    DocTransformer.needsSolrIndexSearcher()
  - getIdSet
```
protected abstract Set<org.apache.lucene.util.BytesRef> getIdSet()
```
  - getKey
```
protected org.apache.lucene.util.BytesRef getKey(org.apache.solr.common.SolrDocument doc)
```