com.yahoo.prelude

Class Index

java.lang.Object

com.yahoo.prelude.Index

public class Index
extends Object

Information about configured settings of a field or field collection (an actual index or not) in a search definition. There are two types of settings:

• Typed commands are checked using a particular is/get method
• Untyped commands are checked using hasCommand and commandIterator

addCommand sets both types.

Author:

Steinar Knutsen, bratseth

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Index.Attribute

Field Summary

Fields

Modifier and Type	Field and Description
private Set<String>	commands
private boolean	dynamicSummary
private boolean	exact True if this is an exact index - which should match tokens containing any characters
private String	exactTerminator The string terminating an exact token in this index, or null to use the default (space)
private boolean	fastSearch
private int	gramSize
private boolean	highlightSummary
private boolean	hostIndex
private boolean	isAttribute
private boolean	isDefaultPosition
private boolean	isNGram
private boolean	literalBoost
private boolean	lowercase
private Index.Attribute[]	matchGroup
private boolean	multivalue
private String	name
private boolean	normalize
static Index	nullIndex The null index - don't use this for name lookups
private boolean	numerical
private boolean	plainTokens
private long	predicateLowerBound
private long	predicateUpperBound
private com.yahoo.language.process.StemMode	stemMode
private boolean	uriIndex

Constructor Summary

Constructors

Constructor and Description
Index(String name)

Method Summary

Modifier and Type	Method and Description
Index	addCommand(String commandString) Adds a type or untyped command string to this
Iterator<String>	commandIterator() Returns an iterator of all the untyped commands of this
boolean	getDynamicSummary()
String	getExactTerminator() Returns the string terminating an exact sequence in this index, or null to use the default (space)
int	getGramSize() Returns the gram size.
boolean	getHighlightSummary()
boolean	getLiteralBoost()
Index.Attribute[]	getMatchGroup()
String	getName() Returns the canonical name of this index, unless it is the null index, which doesn't have a canonical name
boolean	getNormalize() Returns true if the content of this index is normalized
long	getPredicateLowerBound()
long	getPredicateUpperBound()
com.yahoo.language.process.StemMode	getStemMode()
boolean	hasCommand(String commandString) Checks whether this has the given (exact) untyped command string
boolean	hasPlainTokens()
boolean	isAttribute()
boolean	isDefaultPosition()
boolean	isExact() Returns whether this is an exact index, which should match tokens containing any characters
boolean	isFastSearch() Returns true if this is an attribute with fastsearch turned on
boolean	isHostIndex()
boolean	isLowercase() Whether terms in this field are lower cased when indexing.
boolean	isMultivalue() Returns true if this is a multivalue field
boolean	isNGram() Returns true if this is an ngram index (default: false)
boolean	isNull() Returns true if this is the null index
boolean	isNumerical()
boolean	isUriIndex()
void	setAttribute(boolean isAttribute)
void	setDefaultPosition(boolean v)
void	setDynamicSummary(boolean dynamicSummary)
void	setExact(boolean exact, String terminator) Set whether this index should match any kind of characters
void	setFastSearch(boolean fastSearch)
void	setHighlightSummary(boolean highlightSummary)
void	setHostIndex(boolean hostIndex)
void	setLiteralBoost(boolean literalBoost)
void	setLowercase(boolean lowercase) Whether terms in this field are lower cased when indexing.
void	setMatchGroup(String[] attributes)
void	setMultivalue(boolean multivalue)
void	setNGram(boolean nGram, int gramSize)
void	setNormalize(boolean normalize)
void	setNumerical(boolean numerical)
void	setPlainTokens(boolean plainTokens)
private void	setPredicateBounds(String bounds)
void	setStemMode(com.yahoo.language.process.StemMode stemMode)
void	setStemMode(String name)
void	setUriIndex(boolean uriIndex)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

nullIndex

public static final Index nullIndex

The null index - don't use this for name lookups

name

private String name

uriIndex

private boolean uriIndex

hostIndex

private boolean hostIndex

stemMode

private com.yahoo.language.process.StemMode stemMode

matchGroup

private Index.Attribute[] matchGroup

isAttribute

private boolean isAttribute

isDefaultPosition

private boolean isDefaultPosition

dynamicSummary

private boolean dynamicSummary

highlightSummary

private boolean highlightSummary

lowercase

private boolean lowercase

plainTokens

private boolean plainTokens

multivalue

private boolean multivalue

fastSearch

private boolean fastSearch

normalize

private boolean normalize

literalBoost

private boolean literalBoost

numerical

private boolean numerical

predicateUpperBound

private long predicateUpperBound

predicateLowerBound

private long predicateLowerBound

exact

private boolean exact

True if this is an exact index - which should match tokens containing any characters

isNGram

private boolean isNGram

gramSize

private int gramSize

exactTerminator

private String exactTerminator

The string terminating an exact token in this index, or null to use the default (space)

commands

private Set<String> commands

Constructor Detail

Index

public Index(String name)

Method Detail

getName

public String getName()

Returns the canonical name of this index, unless it is the null index, which doesn't have a canonical name

isUriIndex

public boolean isUriIndex()

isDefaultPosition

public boolean isDefaultPosition()

setDefaultPosition

public void setDefaultPosition(boolean v)

setUriIndex

public void setUriIndex(boolean uriIndex)

isHostIndex

public boolean isHostIndex()

setHostIndex

public void setHostIndex(boolean hostIndex)

getStemMode

public com.yahoo.language.process.StemMode getStemMode()

setStemMode

public void setStemMode(com.yahoo.language.process.StemMode stemMode)

setStemMode

public void setStemMode(String name)

addCommand

public Index addCommand(String commandString)

Adds a type or untyped command string to this

setPredicateBounds

private void setPredicateBounds(String bounds)

setLowercase

public void setLowercase(boolean lowercase)

Whether terms in this field are lower cased when indexing.

Parameters:

lowercase - true if terms are lowercased

isLowercase

public boolean isLowercase()

Whether terms in this field are lower cased when indexing.

Returns:

true if terms are lowercased

commandIterator

public Iterator<String> commandIterator()

Returns an iterator of all the untyped commands of this

hasCommand

public boolean hasCommand(String commandString)

Checks whether this has the given (exact) untyped command string

setExact

public void setExact(boolean exact,
                     String terminator)

Set whether this index should match any kind of characters

Parameters:

exact - true to make this index match any kind of characters, not just word and digit ones

terminator - the terminator of an exact sequence (one or more characters), or null to use the default (space)

isExact

public boolean isExact()

Returns whether this is an exact index, which should match tokens containing any characters

getExactTerminator

public String getExactTerminator()

Returns the string terminating an exact sequence in this index, or null to use the default (space)

isNGram

public boolean isNGram()

Returns true if this is an ngram index (default: false)

getGramSize

public int getGramSize()

Returns the gram size. Only used if isNGram is true (default: 2)

setNGram

public void setNGram(boolean nGram,
                     int gramSize)

setDynamicSummary

public void setDynamicSummary(boolean dynamicSummary)

getDynamicSummary

public boolean getDynamicSummary()

setHighlightSummary

public void setHighlightSummary(boolean highlightSummary)

getHighlightSummary

public boolean getHighlightSummary()

isNull

public boolean isNull()

Returns true if this is the null index

getMatchGroup

public Index.Attribute[] getMatchGroup()

setMatchGroup

public void setMatchGroup(String[] attributes)

isAttribute

public boolean isAttribute()

setAttribute

public void setAttribute(boolean isAttribute)

hasPlainTokens

public boolean hasPlainTokens()

setPlainTokens

public void setPlainTokens(boolean plainTokens)

setMultivalue

public void setMultivalue(boolean multivalue)

isMultivalue

public boolean isMultivalue()

Returns true if this is a multivalue field

setFastSearch

public void setFastSearch(boolean fastSearch)

isFastSearch

public boolean isFastSearch()

Returns true if this is an attribute with fastsearch turned on

setNormalize

public void setNormalize(boolean normalize)

getNormalize

public boolean getNormalize()

Returns true if the content of this index is normalized

getLiteralBoost

public boolean getLiteralBoost()

setLiteralBoost

public void setLiteralBoost(boolean literalBoost)

setNumerical

public void setNumerical(boolean numerical)

isNumerical

public boolean isNumerical()

getPredicateUpperBound

public long getPredicateUpperBound()

getPredicateLowerBound

public long getPredicateLowerBound()

toString

public String toString()

Overrides:

toString in class Object