Package com.yahoo.vespa.documentmodel

Class SearchDef

java.lang.Object

com.yahoo.vespa.documentmodel.SearchDef

public class SearchDef
extends java.lang.Object

Since:

2010-02-19

Author:

baldersheim

Constructor Summary

Constructors

Constructor	Description
SearchDef(java.lang.String name)	Will create a SearchDef with the given name

Method Summary

Modifier and Type	Method	Description
SearchDef	add(com.yahoo.document.DataType source)	Adds a document that can be mapped to this search.
SearchDef	add(FieldView view)
SearchDef	add(SearchField field)	Adds a search field to the definition.
SearchDef	addAlias(java.lang.String alias, java.lang.String aliased)
java.util.Map<java.lang.String,SearchField>	getFields()
java.lang.String	getName()	This will provide you with the name of the searchdefinition.
java.util.Map<java.lang.String,FieldView>	getViews()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchDef

public SearchDef(java.lang.String name)

Will create a SearchDef with the given name

Parameters:

name - The name of the searchdefinition

Method Detail

getName

public java.lang.String getName()

This will provide you with the name of the searchdefinition.

Returns:

The name of the searchdefinition.

getFields

public java.util.Map<java.lang.String,SearchField> getFields()

getViews

public java.util.Map<java.lang.String,FieldView> getViews()

add

public SearchDef add(com.yahoo.document.DataType source)

Adds a document that can be mapped to this search.

Parameters:

source - A document that can be mapped to this search.

Returns:

Itself for chaining.

add

public SearchDef add(SearchField field)

Adds a search field to the definition.

Parameters:

field - The field to add.

Returns:

Itself for chaining.

addAlias

public SearchDef addAlias(java.lang.String alias,
                          java.lang.String aliased)

add

public SearchDef add(FieldView view)