atg.search.routing.command.search

Class Sentence

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.Sentence

All Implemented Interfaces:

java.io.Serializable

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

An inspected sentence.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
Sentence()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getEnd() Returns the sentence ending offset within item text
java.util.List<java.lang.String>	getFeatureList() Returns the list of features
java.lang.String	getFeatures() See getFeatureList() for the processed list.
java.lang.String	getField() Returns the sentence's field
int	getId() Returns the sentence index within item
java.lang.String	getRequestTag()
java.lang.String	getSentenceValue() Returns the sentence value
int	getStart() Returns the sentence beginning offset within item text
java.lang.String	getTag() Returns the optional field tag
int	hashCode()
void	setEnd(int pEnd) Sets the sentence ending offset within item text
void	setFeatureList(java.util.List<java.lang.String> pFeatureList) Sets the list of features
void	setFeatures(java.lang.String pFeatures) Sets the unprocessed text fields
void	setField(java.lang.String pField) Sets the sentence's field
void	setId(int pId) Sets the sentence index within item
void	setSentenceValue(java.lang.String pSentenceValue) Sets the sentence value
void	setStart(int pStart) Sets the sentence beginning offset within item text
void	setTag(java.lang.String pTag) Sets the optional field tag

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Sentence

public Sentence()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getSentenceValue

public java.lang.String getSentenceValue()

Returns the sentence value

Returns:

sentence value

setSentenceValue

public void setSentenceValue(java.lang.String pSentenceValue)

Sets the sentence value

Parameters:

pSentenceValue - the sentence value

getId

public int getId()

Returns the sentence index within item

Returns:

Sentence index within item

setId

public void setId(int pId)

Sets the sentence index within item

Parameters:

pId - sentence index within item

getStart

public int getStart()

Returns the sentence beginning offset within item text

Returns:

Sentence beginning offset within item text

setStart

public void setStart(int pStart)

Sets the sentence beginning offset within item text

Parameters:

pStart - the sentence beginning offset within item text

getEnd

public int getEnd()

Returns the sentence ending offset within item text

Returns:

Sentence ending offset within item text

setEnd

public void setEnd(int pEnd)

Sets the sentence ending offset within item text

Parameters:

pEnd - sentence ending offset within item text

getTag

public java.lang.String getTag()

Returns the optional field tag

Returns:

optional field tag

setTag

public void setTag(java.lang.String pTag)

Sets the optional field tag

Parameters:

pTag - optional field tag

getFeatures

public java.lang.String getFeatures()

See getFeatureList() for the processed list.

Returns:

text fields, unprocessed

setFeatures

public void setFeatures(java.lang.String pFeatures)

Sets the unprocessed text fields

Parameters:

pFeatures - unprocessed text fields

getField

public java.lang.String getField()

Returns the sentence's field

Returns:

the sentence's field

setField

public void setField(java.lang.String pField)

Sets the sentence's field

Parameters:

pField - the sentence's field

setFeatureList

public void setFeatureList(java.util.List<java.lang.String> pFeatureList)

Sets the list of features

Parameters:

pFeatureList - the list of features

getFeatureList

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

Returns the list of features

Returns:

list of features

getRequestTag

public java.lang.String getRequestTag()

Specified by:

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

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 sb)
                   throws atg.search.routing.command.IncompleteCommandException

Overrides:

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

Throws:

atg.search.routing.command.IncompleteCommandException