MarkerWordItem (container-search 7.496.44 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.MarkerWordItem

All Implemented Interfaces:

BlockItem, HasIndexItem, IndexedItem, TaggableItem, Cloneable
```
public class MarkerWordItem
extends WordItem
```
Special words known by the index used for marking things. The reserved word itself is not public, while a symbol representation is.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MarkerWordItem`	`createEndOfHost()`	Creates a special word item which marks the end of a host name matching the default index
`static MarkerWordItem`	`createEndOfHost(String indexName)`	Creates a special word item which marks the end of a host name
`static MarkerWordItem`	`createStartOfHost()`	Creates a special word item which marks the start of a host name, matching the default index
`static MarkerWordItem`	`createStartOfHost(String indexName)`	Creates a special word item which marks the start of a host name
`void`	`disclose(Discloser discloser)`
`boolean`	`equals(Object o)`	Returns whether this item is of the same class and contains the same state as the given item.
`protected String`	`getEncodedWord()`	Returns the marker word for encoding
`int`	`hashCode()`
`boolean`	`isEndAnchor()`
`boolean`	`isStartAnchor()`

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

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, shouldParenthize, 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

- Method Detail
  - isStartAnchor
```
public boolean isStartAnchor()
```
  - isEndAnchor
```
public boolean isEndAnchor()
```
  - getEncodedWord
```
protected String getEncodedWord()
```
    Returns the marker word for encoding
    
    Overrides:
    
    getEncodedWord in class WordItem
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: Item
    
    Returns whether this item is of the same class and contains the same state as the given item.
    
    Overrides:
    
    equals in class WordItem
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class WordItem
  - disclose
```
public void disclose(Discloser discloser)
```
    Overrides:
    
    disclose in class WordItem
  - createStartOfHost
```
public static MarkerWordItem createStartOfHost(String indexName)
```
    Creates a special word item which marks the start of a host name
  - createStartOfHost
```
public static MarkerWordItem createStartOfHost()
```
    Creates a special word item which marks the start of a host name, matching the default index
  - createEndOfHost
```
public static MarkerWordItem createEndOfHost(String indexName)
```
    Creates a special word item which marks the end of a host name
  - createEndOfHost
```
public static MarkerWordItem createEndOfHost()
```
    Creates a special word item which marks the end of a host name matching the default index