Package com.yahoo.prelude

Class IndexFacts

java.lang.Object

com.yahoo.prelude.IndexFacts

public class IndexFacts
extends Object

NOTE: We are in the process of moving the functionality of this over to SchemaInfo - see if you can use that before adding usage of this. A central repository for information about indices. Standard usage is

 IndexFacts.Session session = indexFacts.newSession(query); // once when starting to process a query
 session.getIndex(indexName).[get index info]
 

Author:

Steinar Knutsen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	IndexFacts.Session	Create an instance of this to look up index facts with a given query.

Constructor Summary

Constructors

Constructor	Description
IndexFacts()
IndexFacts(IndexModel indexModel)

Method Summary

Modifier and Type	Method	Description
IndexFacts	freeze()	Freeze this to prevent further changes.
String	getDefaultPosition(String sdName)
boolean	hasNGramIndices()	Whether this contains any index which has isNGram()==true.
boolean	isFrozen()	Returns whether it is permissible to update this object
IndexFacts.Session	newSession(Query query)
IndexFacts.Session	newSession(Collection<String> sources, Collection<String> restrict)
IndexFacts.Session	newSession(Collection<String> sources, Collection<String> restrict, Set<String> candidateDocumentTypes)

Methods inherited from class java.lang.Object

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

Constructor Details

IndexFacts

public IndexFacts()

IndexFacts

public IndexFacts(IndexModel indexModel)

Method Details

freeze

public IndexFacts freeze()

Freeze this to prevent further changes.

Returns:

this for chaining

hasNGramIndices

public boolean hasNGramIndices()

Whether this contains any index which has isNGram()==true. This is free to ask on a frozen instance.

isFrozen

public boolean isFrozen()

Returns whether it is permissible to update this object

getDefaultPosition

public String getDefaultPosition(String sdName)

newSession

public IndexFacts.Session newSession(Query query)

newSession

public IndexFacts.Session newSession(Collection<String> sources,
 Collection<String> restrict)

newSession

public IndexFacts.Session newSession(Collection<String> sources,
 Collection<String> restrict,
 Set<String> candidateDocumentTypes)