Package com.attivio.sdk.search

Class QueryFeedback

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class QueryFeedback
extends java.lang.Object
implements java.lang.Cloneable, java.io.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 Description
      QueryFeedback​(java.lang.String stageName, java.lang.String messageName, java.lang.String message)
      Create a new QueryFeedback object.
      QueryFeedback​(java.lang.String stageName, java.lang.String messageName, java.lang.String message, java.util.Map<java.lang.String,​java.lang.Object> properties)
      Create a new QueryFeedback object.

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • QueryFeedback

        public QueryFeedback​(java.lang.String stageName,
                     java.lang.String messageName,
                     java.lang.String message)
        Create a new QueryFeedback object.

      • QueryFeedback

        public QueryFeedback​(java.lang.String stageName,
                     java.lang.String messageName,
                     java.lang.String message,
                     java.util.Map<java.lang.String,​java.lang.Object> properties)
        Create a new QueryFeedback object.

    • Method Detail

      • getStageName

        public java.lang.String getStageName()
        Get the name of the stage that generated this message.

      • setStageName

        public void setStageName​(java.lang.String stageName)
        Set the name of the stage that generated this message.

      • getMessage

        public java.lang.String getMessage()
        Get the message.

      • setMessage

        public void setMessage​(java.lang.String message)
        Set the message.

      • getMessageName

        public java.lang.String getMessageName()
        Get the name of this message.

      • setMessageName

        public void setMessageName​(java.lang.String messageName)
        Set the name of this message.

      • setProperty

        public void setProperty​(java.lang.String name,
                        java.lang.Object value)
        Set a property.

      • getProperty

        public java.lang.Object getProperty​(java.lang.String name)
        Get a property by name or null if it does not exist.

      • getProperties

        public java.util.LinkedHashMap<java.lang.String,​java.lang.Object> getProperties()
        Get all properties.

      • setProperties

        public void setProperties​(BaseTypesMap<java.lang.String,​java.lang.Object> value)
        Set the properties for this feedback.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • clone

        public QueryFeedback clone()
        Overrides:
        clone in class java.lang.Object

      • clone

        public static java.util.ArrayList<QueryFeedback> clone​(java.util.ArrayList<QueryFeedback> value)
        Deep clone an ArrayList of QueryFeedback instances.