Package com.yahoo.prelude.fastsearch

Class DocsumDefinition

java.lang.Object

com.yahoo.prelude.fastsearch.DocsumDefinition

public class DocsumDefinition
extends Object

A docsum definition which knows how to decode a certain class of document summaries. The docsum definition has a name and a list of field definitions

Author:

bratseth, Bjørn Borud

Constructor Summary

Constructors

Constructor	Description
DocsumDefinition(DocumentSummary documentSummary)

Method Summary

Modifier and Type	Method	Description
Object	convert(String fieldName, com.yahoo.data.access.Inspector value)	Returns the given slime value as the type specified in this, or null if the type is not known.
Map<String,DocsumField>	fields()
boolean	isDynamic()	Returns whether this summary contains one or more dynamic fields
String	name()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DocsumDefinition

public DocsumDefinition(DocumentSummary documentSummary)

Method Details

name

public String name()

fields

public Map<String,DocsumField> fields()

isDynamic

public boolean isDynamic()

Returns whether this summary contains one or more dynamic fields

convert

public Object convert(String fieldName,
 com.yahoo.data.access.Inspector value)

Returns the given slime value as the type specified in this, or null if the type is not known. Even in a correctly configured system we may encounter field names for which we do not know the type, in the time period when a configuration is changing and one node has received the new configuration and another has not.

toString

public String toString()

Overrides:

toString in class Object