atg.search.routing.command.search
Class Item

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.Item

All Implemented Interfaces:

java.io.Serializable

public class Item
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable

Search trace for an item

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Item()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static Item	fromXmlParser(atg.search.routing.utils.FastXMLModel pXml, int pItemIdx, boolean pAllowListProperties)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder buf)
java.lang.String	getContentId() Returns the item's content id
java.lang.String	getId() Returns the item's identifier
int	getIdx() Returns the item's index
long	getPhysicalPartitionId() returns the physical partition id for the item.
java.util.Map	getProperties() Returns a String-to-String or String-to-List Map depending on the enclosing response's SearchResponse.isAllowListProperties()
java.lang.String	getRequestTag() Gets the xml element tag used in the request
void	setContentId(java.lang.String pContentId) Sets the item's content id
void	setId(java.lang.String pId) Sets the item's identifier
void	setIdx(int pIdx) Sets the item's index
void	setPhysicalPartitionId(long pPhysicalPartitionId) Sets the physical partition id for sorting purposes.
void	setProperties(java.util.Map properties) Sets a String-to-String or String-to-List Map

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, setParentXMLObject, toString, toXML, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Item

public Item()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getId

public java.lang.String getId()

Returns the item's identifier

Returns:

item's identifier

setId

public void setId(java.lang.String pId)

Sets the item's identifier

Parameters:

pId -

getIdx

public int getIdx()

Returns the item's index

Returns:

item's index

setIdx

public void setIdx(int pIdx)

Sets the item's index

Parameters:

pIdx -

getContentId

public java.lang.String getContentId()

Returns the item's content id

Returns:

the item's content id

setContentId

public void setContentId(java.lang.String pContentId)

Sets the item's content id

Parameters:

pContentId -

fromXmlParser

protected static Item fromXmlParser(atg.search.routing.utils.FastXMLModel pXml,
                                    int pItemIdx,
                                    boolean pAllowListProperties)

getRequestTag

public java.lang.String getRequestTag()

Gets the xml element tag used in the request

Specified by:

getRequestTag in class atg.search.routing.command.SearchXMLObject

Returns:

xml element tag

getAttributeXML

protected void getAttributeXML(java.lang.StringBuilder sb)
                        throws atg.search.routing.command.IncompleteCommandException

Overrides:

getAttributeXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

getBodyXML

protected void getBodyXML(java.lang.StringBuilder buf)
                   throws atg.search.routing.command.IncompleteCommandException

Overrides:

getBodyXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

setPhysicalPartitionId

public void setPhysicalPartitionId(long pPhysicalPartitionId)

Sets the physical partition id for sorting purposes. This is not in the engine's response, and must be set by the caller during response parsing.

Parameters:

pPhysicalPartitionId -

getPhysicalPartitionId

public long getPhysicalPartitionId()

returns the physical partition id for the item. this is not from the xml.

Returns:

the physical partition id for the item. this is not from the xml.

getProperties

public java.util.Map getProperties()

Returns a String-to-String or String-to-List Map depending on the enclosing response's SearchResponse.isAllowListProperties()

Returns:

String-to-String or String-to-List Map depending on the enclosing response's SearchResponse.isAllowListProperties()

setProperties

public void setProperties(java.util.Map properties)

Sets a String-to-String or String-to-List Map

Parameters:

properties - String-to-String or String-to-List Map