TransformerFactory (Solr 9.2.1 core API)

java.lang.Object
- org.apache.solr.response.transform.TransformerFactory

All Implemented Interfaces:

NamedListInitializedPlugin

Direct Known Subclasses:

ChildDocTransformerFactory, CoreAugmenterFactory, DocIdAugmenterFactory, ElevatedMarkerFactory, ExcludedMarkerFactory, ExplainAugmenterFactory, GeoTransformerFactory, RawValueTransformerFactory, ShardAugmenterFactory, SubQueryAugmenterFactory, ValueAugmenterFactory
```
public abstract class TransformerFactory
extends Object
implements NamedListInitializedPlugin
```
New instance for each request

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`TransformerFactory.FieldRenamer`	The `TransformerFactory.FieldRenamer` interface should be implemented by any `TransformerFactory` capable of generating transformers that might rename fields, and should implement `TransformerFactory.FieldRenamer.create(String, SolrParams, SolrQueryRequest, Map, Set)` in place of `create(String, SolrParams, SolrQueryRequest)` (with the latter method overridden to throw `UnsupportedOperationException`).

Field Summary

Fields
Modifier and Type Field Description

static Map<String,TransformerFactory> defaultFactories

protected String defaultUserArgs

Constructor Summary

Constructors
Constructor Description

TransformerFactory()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract DocTransformer`	`create(String field, org.apache.solr.common.params.SolrParams params, SolrQueryRequest req)`
`void`	`init(org.apache.solr.common.util.NamedList<?> args)`	`init` will be called just once, immediately after creation.

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

- Field Detail
  - defaultUserArgs
```
protected String defaultUserArgs
```
  - defaultFactories
```
public static final Map<String,TransformerFactory> defaultFactories
```
- Constructor Detail
  - TransformerFactory
```
public TransformerFactory()
```
- Method Detail
  - init
```
public void init(org.apache.solr.common.util.NamedList<?> args)
```
    Description copied from interface: NamedListInitializedPlugin
    
    init will be called just once, immediately after creation.
    Source of the initialization arguments will typically be solrconfig.xml, but will ultimately depends on the plugin itself
    
    Specified by:
    
    init in interface NamedListInitializedPlugin
    
    Parameters:
    
    args - non-null list of initialization parameters (may be empty)
  - create
```
public abstract DocTransformer create(String field,
                                      org.apache.solr.common.params.SolrParams params,
                                      SolrQueryRequest req)
```