atg.search.routing.command.search
Class TraceExpression

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

All Implemented Interfaces:

java.io.Serializable

public class TraceExpression
extends atg.search.routing.command.SearchXMLObject

An expression that determines which items should be traced. One of URL, HDoc, or Property is required. If sending HDocs to a multi-partition index, then the HDoc must include the content id. See addHDoc(HDoc)

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

TraceExpression()

Method Summary

protected static TraceExpression	fromXmlParser(atg.search.routing.utils.SearchMessageNode xml) creates a new TraceExpression from the xml parser
java.util.List<HDoc>	getHDocs() Returns the List of HDocs
java.util.List<IndexedItemProperty>	getProperties() Returns the List of property names and values
java.lang.String	getRequestTag()
java.util.List<java.lang.String>	getUrls() Returns the list of urls
void	setHDocs(java.util.List<HDoc> pHDocs) Sets the List of HDocs
void	setProperties(java.util.List<IndexedItemProperty> pProperties) Sets the List of property names and values
void	setUrls(java.util.List<java.lang.String> pUrls) Sets the list of urls
void	setXml(java.lang.String pXml) Sets the xml from a string, even if the root element is not the trace expression.
java.lang.String	toString()
java.lang.String	toXML()
static TraceExpression	valueOf(java.lang.String pXml) parses trace expression xml and returns a populated TraceExpression

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

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, getBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

TraceExpression

public TraceExpression()

Method Detail

getHDocs

public java.util.List<HDoc> getHDocs()

Returns the List of HDocs

Returns:

List of HDocs

setHDocs

public void setHDocs(java.util.List<HDoc> pHDocs)

Sets the List of HDocs

Parameters:

pHDocs - list of HDocs

getUrls

public java.util.List<java.lang.String> getUrls()

Returns the list of urls

Returns:

list of urls

setUrls

public void setUrls(java.util.List<java.lang.String> pUrls)

Sets the list of urls

Parameters:

pUrls - list of urls

getProperties

public java.util.List<IndexedItemProperty> getProperties()

Returns the List of property names and values

Returns:

List of property names and values

setProperties

public void setProperties(java.util.List<IndexedItemProperty> pProperties)

Sets the List of property names and values

Parameters:

pProperties - name and value list

toXML

public java.lang.String toXML()

Overrides:

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

valueOf

public static TraceExpression valueOf(java.lang.String pXml)

parses trace expression xml and returns a populated TraceExpression

Parameters:

pXml - well-formed and decoded xml

Returns:

a populated TraceExpression, or null if the input is null or empty

fromXmlParser

protected static TraceExpression fromXmlParser(atg.search.routing.utils.SearchMessageNode xml)

creates a new TraceExpression from the xml parser

Parameters:

xml - an xml parser

Returns:

a new TraceExpression initialized from the parser

setXml

public void setXml(java.lang.String pXml)

Sets the xml from a string, even if the root element is not the trace expression.

Parameters:

pXml - the xml

toString

public java.lang.String toString()

Overrides:

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

getRequestTag

public java.lang.String getRequestTag()

Specified by:

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