Package com.yahoo.schema
Class Index
java.lang.Object
com.yahoo.schema.Index
- All Implemented Interfaces:
Serializable
,Cloneable
An index definition in a schema.
Two indices are equal if they have the same name and the same settings, except
alias settings (which are excluded).
- Author:
- bratseth
- See Also:
-
Nested Class Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds an alias to this index nameReturns a read-only iterator of the aliases (Strings) to this index nameclone()
Makes a deep copy of this indexcopy()
boolean
Returns the boolean index definitiongetName()
Returns the rank type of this field, or null if nothing is setReturn the stemming setting of this index, may be nullgetStemming
(Schema schema) Whether this field should be stemmed in this search definition, this is never nullgetType()
Returns the index engine typeint
hashCode()
boolean
isPrefix()
Returns whether this index supports prefix search, default is falsevoid
Sets the boolean index definitionvoid
setHnswIndexParams
(HnswIndexParams params) void
setInterleavedFeatures
(boolean value) void
void
setPrefix
(boolean prefix) Sets whether this index supports prefix searchvoid
setRankType
(RankType rankType) Sets the rank type of this fieldvoid
setStemming
(Stemming stemming) Sets how this field should be stemmed, or set to null to use the default.void
setType
(Index.Type type) Sets the index engine typetoString()
boolean
-
Constructor Details
-
Index
-
Index
-
-
Method Details
-
setName
-
getName
-
setRankType
Sets the rank type of this field -
getRankType
Returns the rank type of this field, or null if nothing is set -
getStemming
Return the stemming setting of this index, may be null -
getStemming
Whether this field should be stemmed in this search definition, this is never null -
setStemming
Sets how this field should be stemmed, or set to null to use the default. -
isPrefix
public boolean isPrefix()Returns whether this index supports prefix search, default is false -
setPrefix
public void setPrefix(boolean prefix) Sets whether this index supports prefix search -
addAlias
Adds an alias to this index name -
aliasIterator
Returns a read-only iterator of the aliases (Strings) to this index name -
equals
-
hashCode
public int hashCode() -
toString
-
clone
Makes a deep copy of this index -
copy
-
getType
Returns the index engine type -
setType
Sets the index engine type -
getBooleanIndexDefiniton
Returns the boolean index definition -
setBooleanIndexDefiniton
Sets the boolean index definition -
getHnswIndexParams
-
setHnswIndexParams
-
setInterleavedFeatures
public void setInterleavedFeatures(boolean value) -
useInterleavedFeatures
public boolean useInterleavedFeatures()
-