com.plumtree.server.search
Interface IPTSWeightedFieldList

public interface IPTSWeightedFieldList

A weighted list of IPTSField objects. Used when setting the default field(s) to be searched by text search queries. See IPTSSearchableCollection.TextQueryDefault and IPTSQueryRequest.setTextQueryDefaultFields.

Method Summary

void	addField(IPTSField field, float weight) Add a field to this list.
IPTSField	getFieldAt(int position) Returns a single field from the list.
int	getSize() Returns the number of fields already on the list.
float	getWeightAt(int position) Returns a single weight from the list.

Method Detail

addField

void addField(IPTSField field,
              float weight)

Add a field to this list.

Parameters:

field - field to add to the list.

weight - weight of the field, relative to others in the list; must be positive. If all fields should have the same weight, use 1.0f for all weights.

getSize

int getSize()

Returns the number of fields already on the list.

getFieldAt

IPTSField getFieldAt(int position)

Returns a single field from the list.

Parameters:

position - position on the list, from 0 to GetSize()-1.

getWeightAt

float getWeightAt(int position)

Returns a single weight from the list.

Parameters:

position - position on the list, from 0 to GetSize()-1.