Package org.apache.solr.search.grouping.distributed.shardresultserializer

Interface ShardResultTransformer<T,R>

All Known Implementing Classes:
SearchGroupsResultTransformer, TopGroupsResultTransformer
public interface ShardResultTransformer<T,R>
A ShardResultTransformer is responsible for transforming a grouped shard result into group related structures (such as TopGroups and SearchGroup) and visa versa.
WARNING: This API is experimental and might change in incompatible ways in the next release.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<Object>>
    transform(T data)
    Transforms data to a NamedList structure for serialization purposes.
    R
    transformToNative(org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<?>> shardResponse, org.apache.lucene.search.Sort groupSort, org.apache.lucene.search.Sort withinGroupSort, String shard)
    Transforms the specified shard response into native structures.

  • Method Details

    • transform

      org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<Object>> transform(T data) throws IOException
      Transforms data to a NamedList structure for serialization purposes.
      Parameters:
      data - The data to be transformed
      Returns:
      NamedList structure
      Throws:
      IOException - If I/O related errors occur during transforming

    • transformToNative

      R transformToNative(org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<?>> shardResponse, org.apache.lucene.search.Sort groupSort, org.apache.lucene.search.Sort withinGroupSort, String shard)
      Transforms the specified shard response into native structures.
      Parameters:
      shardResponse - The shard response containing data in a NamedList structure
      groupSort - The group sort
      withinGroupSort - The sort inside a group
      shard - The shard address where the response originated from
      Returns:
      native structure of the data