DocsumDefinitionSet (container-search 7.543.30 API)

java.lang.Object
- com.yahoo.prelude.fastsearch.DocsumDefinitionSet

public final class DocsumDefinitionSet
extends Object

A set of docsum definitions

Author:: bratseth, Bjørn Borud

Field Summary

Fields
Modifier and Type Field Description

static int SLIME_MAGIC_ID

Constructor Summary

Constructors
Constructor Description

DocsumDefinitionSet(DocumentdbInfoConfig.Documentdb config)

DocsumDefinitionSet(Collection<DocsumDefinition> docsumDefinitions)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DocsumDefinition`	`getDocsum(String summaryClass)`	Returns the summary definition of the given name, or the default if not found.
`String`	`lazyDecode(String summaryClass, byte[] data, FastHit hit)`	Makes data available for decoding for the given hit.
`int`	`size()`
`String`	`toString()`

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

- Field Detail
  - SLIME_MAGIC_ID
```
public static final int SLIME_MAGIC_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DocsumDefinitionSet
```
public DocsumDefinitionSet(DocumentdbInfoConfig.Documentdb config)
```
  - DocsumDefinitionSet
```
public DocsumDefinitionSet(Collection<DocsumDefinition> docsumDefinitions)
```
- Method Detail
  - getDocsum
```
public DocsumDefinition getDocsum(String summaryClass)
```
    Returns the summary definition of the given name, or the default if not found.
    
    Throws:
    
    ConfigurationException - if the requested summary class is not found and there is none called "default"
  - lazyDecode
```
public final String lazyDecode(String summaryClass,
                               byte[] data,
                               FastHit hit)
```
    Makes data available for decoding for the given hit.
    
    Parameters:
    
    summaryClass - the requested summary class
    
    data - docsum data from backend
    
    hit - the Hit corresponding to this document summary
    
    Returns:
    
    Error message or null on success.
    
    Throws:
    
    ConfigurationException - if the summary class of this hit is missing
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - size
```
public int size()
```