org.gcube.indexmanagement.common

Class IndexField

java.lang.Object

org.gcube.indexmanagement.common.IndexField

public class IndexField
extends Object

Represent the characteristics of a single field in a RowSet.

See Also:

FullTextIndexType

Field Summary

Fields

Modifier and Type	Field and Description
float	boost The boost value to use for this field during ranking
ArrayList	childrenFields The child fields of this field
boolean	highlightable An indicator of whether to include or exclude the field in the snippets
boolean	index An indicator of whether to index the field
String	name The name of the field
boolean	returned An indicator of whether to return the field (in the results from a query)
boolean	sort An indicator of whether to sort the field
boolean	store An indicator of whether to store the field
boolean	tokenize An indicator of whether to tokenize the field
String	type The type of the field

Constructor Summary

Constructors

Constructor and Description
IndexField() Empty constructor.
IndexField(String name, String type, boolean index, boolean tokenize, boolean store, boolean returned, boolean highlightable, boolean sort, float boost) Constructor setting all field attributes.

Method Summary

Modifier and Type	Method and Description
void	addChildField(IndexField field) Adds a IndexField sub field to this field
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

The name of the field

type

public String type

The type of the field

index

public boolean index

An indicator of whether to index the field

tokenize

public boolean tokenize

An indicator of whether to tokenize the field

store

public boolean store

An indicator of whether to store the field

returned

public boolean returned

An indicator of whether to return the field (in the results from a query)

highlightable

public boolean highlightable

An indicator of whether to include or exclude the field in the snippets

sort

public boolean sort

An indicator of whether to sort the field

boost

public float boost

The boost value to use for this field during ranking

childrenFields

public ArrayList childrenFields

The child fields of this field

Constructor Detail

IndexField

public IndexField()

Empty constructor. The field attributes must be set in subsequent calls.

IndexField

public IndexField(String name,
                  String type,
                  boolean index,
                  boolean tokenize,
                  boolean store,
                  boolean returned,
                  boolean highlightable,
                  boolean sort,
                  float boost)

Constructor setting all field attributes.

Parameters:

name - - The name of the new field

index - - An indicator of whether to index the new field

tokenize - - An indicator of whether to tokenize the new field

store - - An indicator of whether to store the new field

returned - - An indicator of whether to return the new field (in the results from a query)

sort - - An indicator of whether to sort the new field

boost - - The boost value to use for the new field during ranking

Method Detail

addChildField

public void addChildField(IndexField field)

Adds a IndexField sub field to this field

Parameters:

field - IndexField - the sub field to be added

toString

public String toString()

Overrides:

toString in class Object