Package com.yahoo.prelude
Class IndexFacts
- java.lang.Object
-
- com.yahoo.prelude.IndexFacts
-
public class IndexFacts extends Object
A central repository for information about indices. Standard usage isIndexFacts.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>
clustersHavingSearchDefinition(String searchDefinitionName)
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 objectIndexFacts.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)
-
-
-
Constructor Detail
-
IndexFacts
public IndexFacts()
-
IndexFacts
public IndexFacts(IndexModel indexModel)
-
-
Method Detail
-
clustersHavingSearchDefinition
public List<String> clustersHavingSearchDefinition(String searchDefinitionName)
-
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
-
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)
-
-