Package com.yahoo.vespa.documentmodel

Class SummaryField

java.lang.Object

com.yahoo.vespa.objects.FieldBase

com.yahoo.document.Field

com.yahoo.vespa.documentmodel.SummaryField

All Implemented Interfaces:

com.yahoo.document.fieldset.FieldSet, TypedKey, Serializable, Cloneable, Comparable

public class SummaryField
extends com.yahoo.document.Field
implements Cloneable, TypedKey

A summary field

Author:

bratseth

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SummaryField.Property	A name-value property (used for smart summary)
static class	SummaryField.Source	A source (field name).
static class	SummaryField.VsmCommand	The command used when using data from this SummaryField to generate StreamingSummary config (vsmsummary).

Field Summary

Fields inherited from class com.yahoo.document.Field

dataType, fieldId

Constructor Summary

Constructors

Constructor	Description
SummaryField(com.yahoo.document.Field field)	Creates a summary field with NONE as transform
SummaryField(com.yahoo.document.Field field, SummaryTransform transform)
SummaryField(String name, com.yahoo.document.DataType type)	Creates a summary field with NONE as transform
SummaryField(String name, com.yahoo.document.DataType type, SummaryTransform transform)

Method Summary

Modifier and Type	Method	Description
void	addDestination(String name)
void	addDestinations(Iterable<String> names)
void	addProperty(String name, String value)	Adds a property to this summary field
void	addSource(SummaryField.Source source)
void	addSource(String name)
SummaryField	clone()
Set<String>	getDestinations()	Returns an modifiable view of the destination set owned by this
List<SummaryField.Property>	getProperties()
String	getSingleSource()	Returns the first source name of this, or the field name if no source has been set
int	getSourceCount()
String	getSourceField()	Returns the first source field of this, or null if the source field is not present
Set<SummaryField.Source>	getSources()	Returns a modifiable set of the sources of this
SummaryTransform	getTransform()
SummaryField.VsmCommand	getVsmCommand()
boolean	hasSource(String name)
boolean	isImplicit()
SummaryField	mergeWith(SummaryField merge)	Returns a summary field which merges the settings in the given field into this field
void	setImplicit(boolean implicit)
void	setTransform(SummaryTransform transform)
void	setVsmCommand(SummaryField.VsmCommand vsmCommand)
Iterator<SummaryField.Source>	sourceIterator()
String	toLocateString()	Returns a string which aids locating this field in the source search definition
String	toString()

Methods inherited from class com.yahoo.document.Field

calculateIdV7, compareTo, contains, equals, getDataType, getId, getId, hasForcedId, hashCode, isHeader, setDataType, setHeader, setId

Methods inherited from class com.yahoo.vespa.objects.FieldBase

getName

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yahoo.searchdefinition.document.TypedKey

getDataType, getName, setDataType

Constructor Detail

SummaryField

public SummaryField(String name,
                    com.yahoo.document.DataType type)

Creates a summary field with NONE as transform

SummaryField

public SummaryField(com.yahoo.document.Field field)

Creates a summary field with NONE as transform

SummaryField

public SummaryField(com.yahoo.document.Field field,
                    SummaryTransform transform)

SummaryField

public SummaryField(String name,
                    com.yahoo.document.DataType type,
                    SummaryTransform transform)

Method Detail

setImplicit

public void setImplicit(boolean implicit)

isImplicit

public boolean isImplicit()

setTransform

public void setTransform(SummaryTransform transform)

getTransform

public SummaryTransform getTransform()

getSourceField

public String getSourceField()

Returns the first source field of this, or null if the source field is not present

addSource

public void addSource(String name)

addSource

public void addSource(SummaryField.Source source)

sourceIterator

public Iterator<SummaryField.Source> sourceIterator()

getSourceCount

public int getSourceCount()

getSources

public Set<SummaryField.Source> getSources()

Returns a modifiable set of the sources of this

getSingleSource

public String getSingleSource()

Returns the first source name of this, or the field name if no source has been set

addDestination

public void addDestination(String name)

addDestinations

public final void addDestinations(Iterable<String> names)

getDestinations

public Set<String> getDestinations()

Returns an modifiable view of the destination set owned by this

mergeWith

public SummaryField mergeWith(SummaryField merge)

Returns a summary field which merges the settings in the given field into this field

Parameters:

merge - the field to merge with this, if null, the merged field is this field

Throws:

RuntimeException - if the two fields can not be merged

hasSource

public boolean hasSource(String name)

toString

public String toString()

Overrides:

toString in class com.yahoo.document.Field

toLocateString

public String toLocateString()

Returns a string which aids locating this field in the source search definition

clone

public SummaryField clone()

Specified by:

clone in interface com.yahoo.document.fieldset.FieldSet

Overrides:

clone in class com.yahoo.document.Field

getVsmCommand

public SummaryField.VsmCommand getVsmCommand()

setVsmCommand

public void setVsmCommand(SummaryField.VsmCommand vsmCommand)

addProperty

public void addProperty(String name,
                        String value)

Adds a property to this summary field

getProperties

public List<SummaryField.Property> getProperties()