PrefixItem (container-search 7.563.7 API)

java.lang.Object
- com.yahoo.prelude.query.Item
- - com.yahoo.prelude.query.SimpleTaggableItem
  - - com.yahoo.prelude.query.SimpleIndexedItem
    - - com.yahoo.prelude.query.TermItem
      - com.yahoo.prelude.query.WordItem
        
        com.yahoo.prelude.query.PrefixItem

All Implemented Interfaces:

BlockItem, HasIndexItem, IndexedItem, TaggableItem, Cloneable
```
public class PrefixItem
extends WordItem
```
A word which matches beginnings of words instead of complete words

Author:

bratseth

Nested Class Summary
- Nested classes/interfaces inherited from class com.yahoo.prelude.query.Item
  Item.ItemCreator, Item.ItemType

Field Summary
- Fields inherited from class com.yahoo.prelude.query.Item
  connectedBacklink, connectedItem, connectivity, DEFAULT_WEIGHT, explicitSignificance, significance, uniqueID

Constructor Summary

Constructors
Constructor	Description
`PrefixItem(String prefix)`
`PrefixItem(String prefix, boolean isFromQuery)`
`PrefixItem(String prefix, String indexName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Item.ItemType`	`getItemType()`	Return the enumerated type of this item.
`String`	`getName()`	Returns the name of this item
`String`	`stringValue()`	Returns this word as it should be used in executing the query.

Methods inherited from class com.yahoo.prelude.query.WordItem
appendHeadingString, disclose, encodeThis, equals, getEncodedWord, getIndexedString, getNumWords, getRawWord, getSegmentIndex, getWord, hashCode, isFromSegmented, isLowercased, isStemmed, isWords, setFromSegmented, setLowercased, setSegmentIndex, setStemmed, setValue, setWord, setWords

Methods inherited from class com.yahoo.prelude.query.TermItem
appendBodyString, encode, getOrigin, getSegmentingRule, getTermCount, isFromQuery, isNormalizable, setFromQuery, setNormalizable, setOrigin, setSegmentingRule

Methods inherited from class com.yahoo.prelude.query.SimpleIndexedItem
appendIndexString, getIndexName, setIndexName

Methods inherited from class com.yahoo.prelude.query.SimpleTaggableItem
getConnectedItem, getConnectivity, getSignificance, getUniqueID, hasExplicitSignificance, hasUniqueID, setConnectivity, setExplicitSignificance, setSignificance, setUniqueID

Methods inherited from class com.yahoo.prelude.query.Item
addAnnotation, clone, getAnnotation, getBytes, getCode, getCreator, getLabel, getLanguage, getParent, getWeight, hasAnnotation, hasConnectivityBackLink, isFilter, isFromSpecialToken, isProtected, isRanked, isRoot, putBytes, putString, setCreator, setFilter, setFromSpecialToken, setHasUniqueID, setLabel, setLanguage, setParent, setPositionData, setProtected, setRanked, setWeight, shouldParenthesize, toString, usePositionData

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yahoo.prelude.query.HasIndexItem
getIndexName

- Constructor Detail
  - PrefixItem
```
public PrefixItem(String prefix)
```
  - PrefixItem
```
public PrefixItem(String prefix,
                  boolean isFromQuery)
```
  - PrefixItem
```
public PrefixItem(String prefix,
                  String indexName)
```
- Method Detail
  - getItemType
```
public Item.ItemType getItemType()
```
    Description copied from class: Item
    
    Return the enumerated type of this item.
    
    Overrides:
    
    getItemType in class WordItem
  - getName
```
public String getName()
```
    Description copied from class: Item
    
    Returns the name of this item
    
    Overrides:
    
    getName in class WordItem
  - stringValue
```
public String stringValue()
```
    Description copied from class: WordItem
    
    Returns this word as it should be used in executing the query. This is usually (but not always) a normalized and stemmed form
    
    Specified by:
    
    stringValue in interface BlockItem
    
    Overrides:
    
    stringValue in class WordItem