com.attivio.sdk.search

Class QueryFeedback

java.lang.Object

com.attivio.sdk.search.QueryFeedback

All Implemented Interfaces:

Serializable, Cloneable

public class QueryFeedback
extends Object
implements Cloneable, Serializable

An arbitrary feedback message generated by a query or response transformer.

For instance, a query transformer might use the feedback mechanism to insert alternative spelling suggestions into the query response.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryFeedback(String stageName, String messageName, String message) Create a new QueryFeedback object.
QueryFeedback(String stageName, String messageName, String message, Map<String,Object> properties) Create a new QueryFeedback object.

Method Summary

Modifier and Type	Method and Description
QueryFeedback	clone()
static ArrayList<QueryFeedback>	clone(ArrayList<QueryFeedback> value) Deep clone an ArrayList of QueryFeedback instances.
boolean	equals(Object other)
String	getMessage() Get the message.
String	getMessageName() Get the name of this message.
LinkedHashMap<String,Object>	getProperties() Get all properties.
Object	getProperty(String name) Get a property by name or null if it does not exist.
String	getStageName() Get the name of the stage that generated this message.
int	hashCode()
void	setMessage(String message) Set the message.
void	setMessageName(String messageName) Set the name of this message.
void	setProperties(BaseTypesMap<String,Object> properties) Set the properties for this feedback.
void	setProperty(String name, Object value) Set a property.
void	setStageName(String stageName) Set the name of the stage that generated this message.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFeedback

public QueryFeedback(String stageName,
                     String messageName,
                     String message)

Create a new QueryFeedback object.

QueryFeedback

public QueryFeedback(String stageName,
                     String messageName,
                     String message,
                     Map<String,Object> properties)

Create a new QueryFeedback object.

Method Detail

getStageName

public String getStageName()

Get the name of the stage that generated this message.

setStageName

public void setStageName(String stageName)

Set the name of the stage that generated this message.

getMessage

public String getMessage()

Get the message.

setMessage

public void setMessage(String message)

Set the message.

getMessageName

public String getMessageName()

Get the name of this message.

setMessageName

public void setMessageName(String messageName)

Set the name of this message.

setProperty

public void setProperty(String name,
                        Object value)

Set a property.

getProperty

public Object getProperty(String name)

Get a property by name or null if it does not exist.

getProperties

public LinkedHashMap<String,Object> getProperties()

Get all properties.

setProperties

public void setProperties(BaseTypesMap<String,Object> properties)

Set the properties for this feedback.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

clone

public QueryFeedback clone()

Overrides:

clone in class Object

clone

public static ArrayList<QueryFeedback> clone(ArrayList<QueryFeedback> value)

Deep clone an ArrayList of QueryFeedback instances.