Package com.yahoo.prelude.query

Class SegmentItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.CompositeItem

com.yahoo.prelude.query.SegmentItem

All Implemented Interfaces:

BlockItem, HasIndexItem, java.lang.Cloneable

Direct Known Subclasses:

AndSegmentItem, TaggableSegmentItem

public abstract class SegmentItem
extends CompositeItem
implements BlockItem

An immutable and'ing of a collection of sub-expressions. It does not extend AndItem to avoid code using instanceof handling it as an AndItem.

Author:

Steinar Knutsen

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
SegmentItem(java.lang.String rawWord, java.lang.String current, boolean isFromQuery, boolean stemmed)	Creates a new segment item
SegmentItem(java.lang.String rawWord, java.lang.String current, boolean isFromQuery, boolean stemmed, Substring origin)	Creates a new segment item

Method Summary

Modifier and Type	Method	Description
void	addItem(int index, Item item)	Inserts the item at a position and increases the index of existing items starting on this position by one
void	addItem(Item item)
SegmentItem	clone()	Return a deep copy of this object
void	disclose(com.yahoo.prelude.query.textualrepresentation.Discloser discloser)
java.lang.String	getNormalized()
int	getNumWords()
Substring	getOrigin()	Returns null right now
java.lang.String	getRawWord()	The untransformed raw text from the user serving as base for this item.
SegmentingRule	getSegmentingRule()	If the block has to be resegmented, what operator should be chosen if it is necessary to change operator?
boolean	isFromQuery()	Is this block of text conceptually from the user query?
boolean	isFromUser()
boolean	isLocked()	Whether this composite is in a mutable state.
boolean	isStemmed()
boolean	isWords()	Does this item represent "usual words"?
void	lock()	Make composite immutable if this is supported.
Item	removeItem(int index)	Removes the item at the given index
boolean	removeItem(Item item)	Removes the given item.
void	setFromUser(boolean isFromUser)
void	setSegmentingRule(SegmentingRule segmentingRule)
java.lang.String	stringValue()	Returns the value of this term as a string

Methods inherited from class com.yahoo.prelude.query.CompositeItem

adding, appendBodyString, encode, encodeThis, encodingArity, ensureNotInSubtree, equals, extractSingleChild, getItem, getItemCount, getItemIndex, getItemIterator, getTermCount, hashCode, items, setIndexName, setItem, shouldParenthize

Methods inherited from class com.yahoo.prelude.query.Item

addAnnotation, appendHeadingString, getAnnotation, getBytes, getCode, getCreator, getItemType, getLabel, getLanguage, getName, getParent, getWeight, hasAnnotation, hasConnectivityBackLink, hasUniqueID, isFilter, isFromSpecialToken, isProtected, isRanked, isRoot, putBytes, putString, setCreator, setFilter, setFromSpecialToken, setHasUniqueID, setLabel, setLanguage, setParent, setPositionData, setProtected, setRanked, setWeight, 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

SegmentItem

public SegmentItem(java.lang.String rawWord,
                   java.lang.String current,
                   boolean isFromQuery,
                   boolean stemmed)

Creates a new segment item

Parameters:

rawWord - the raw form of this segment as received in the request

current - the current transformed version of the raw form, or the raw form repeated if no normalized form is known

isFromQuery - whether this segment stems from the query received in the request

stemmed - whether this is stemmed

SegmentItem

public SegmentItem(java.lang.String rawWord,
                   java.lang.String current,
                   boolean isFromQuery,
                   boolean stemmed,
                   Substring origin)

Creates a new segment item

Parameters:

rawWord - the raw form of this segment as received in the request

current - the current transformed version of the raw form, or the raw form repeated if no normalized form is known

isFromQuery - whether this segment stems from the query received in the request

stemmed - whether this is stemmed

origin - TODO

Method Detail

getRawWord

public java.lang.String getRawWord()

Description copied from interface: BlockItem

The untransformed raw text from the user serving as base for this item.

Specified by:

getRawWord in interface BlockItem

getNormalized

public java.lang.String getNormalized()

stringValue

public java.lang.String stringValue()

Description copied from interface: BlockItem

Returns the value of this term as a string

Specified by:

stringValue in interface BlockItem

isFromQuery

public boolean isFromQuery()

Description copied from interface: BlockItem

Is this block of text conceptually from the user query?

Specified by:

isFromQuery in interface BlockItem

isStemmed

public boolean isStemmed()

Specified by:

isStemmed in interface BlockItem

lock

public void lock()

Description copied from class: CompositeItem

Make composite immutable if this is supported.

Overrides:

lock in class CompositeItem

isLocked

public boolean isLocked()

Description copied from class: CompositeItem

Whether this composite is in a mutable state.

Overrides:

isLocked in class CompositeItem

getNumWords

public int getNumWords()

Specified by:

getNumWords in interface HasIndexItem

Returns:

how many phrase words does this item contain

addItem

public void addItem(Item item)

Overrides:

addItem in class CompositeItem

addItem

public void addItem(int index,
                    Item item)

Description copied from class: CompositeItem

Inserts the item at a position and increases the index of existing items starting on this position by one

Overrides:

addItem in class CompositeItem

removeItem

public Item removeItem(int index)

Description copied from class: CompositeItem

Removes the item at the given index

Overrides:

removeItem in class CompositeItem

Parameters:

index - the index of the item to remove

Returns:

the removed item

removeItem

public boolean removeItem(Item item)

Description copied from class: CompositeItem

Removes the given item. Does nothing if the item is not present.

Overrides:

removeItem in class CompositeItem

Parameters:

item - the item to remove

Returns:

whether the item was removed

clone

public SegmentItem clone()

Return a deep copy of this object

Overrides:

clone in class CompositeItem

isWords

public boolean isWords()

Description copied from interface: BlockItem

Does this item represent "usual words"?

Specified by:

isWords in interface BlockItem

isFromUser

public boolean isFromUser()

setFromUser

public void setFromUser(boolean isFromUser)

getOrigin

public Substring getOrigin()

Returns null right now

Specified by:

getOrigin in interface BlockItem

disclose

public void disclose(com.yahoo.prelude.query.textualrepresentation.Discloser discloser)

Overrides:

disclose in class CompositeItem

getSegmentingRule

public SegmentingRule getSegmentingRule()

Description copied from interface: BlockItem

If the block has to be resegmented, what operator should be chosen if it is necessary to change operator?

Specified by:

getSegmentingRule in interface BlockItem

setSegmentingRule

public void setSegmentingRule(SegmentingRule segmentingRule)