Package com.attivio.sdk.client.trigger

Class TriggerDictionaryInfo

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class TriggerDictionaryInfo
extends TriggerDictionaryName
    Defines a dictionary of triggers.

    This dictionary can then be used for performing entity extraction based on complex queries.

    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      TriggerDictionaryInfo clone()  
      boolean equals​(java.lang.Object other)  
      java.lang.String getDescription()
      Get an optional description for this trigger dictionary.
      java.lang.String getEntityNameField()
      Get the name of the output field for storing the entity names for matching triggers.
      java.lang.String getEntityScoreField()
      Get the name of the output field for storing the per-entity scores for matching triggers.
      java.util.Date getLastCompiled()
      Get the time this dictionary was last compiled, or null if unknown.
      java.util.Date getLastModified()
      Get the time this dictionary was last modified, or null if unknown.
      java.util.Date getLastPublished()
      Get the time this dictionary was last published, or null if unknown.
      java.lang.String getSchemaName()
      Get the name of the schema to use for processing queries and documents.
      java.lang.String getSynonymDictionary()
      Get the name of the synonym dictionary to use for synonym expansion.
      java.lang.String getTriggerNameField()
      Get the name of the output field for storing the names of matching triggers.
      java.lang.String getTriggerPayloadField()
      Get the name of the output field that will contain payloads for matching triggers.
      java.lang.String getTriggerScoreField()
      Get the name of the output field for storing aggregate score for all matching triggers.
      java.lang.String getTriggerVersionField()
      Get the name of the output field that will contain a version identifer for the dictionary used to apply triggers.
      int hashCode()  
      boolean isCompiled()
      Get if all outstanding changes to this dictionary have been compiled.
      boolean isEntityNameScopes()
      If true scopes will be added for entity names for matching triggers.
      boolean isPublished()
      Get if all outstanding changes to this dictionary have been published.
      boolean isTriggerNameScopes()
      If true scopes will be added for trigger names for matching triggers.
      void setCompiled​(boolean value)
      Set if all outstanding changes to this dictionary have been compiled.
      void setDescription​(java.lang.String value)
      Set an optional description for this trigger dictionary.
      void setEntityNameField​(java.lang.String value)
      Set the name of the output field for storing the entity names for matching triggers.
      void setEntityNameScopes​(boolean value)
      If true scopes will be added for entity names for matching triggers.
      void setEntityScoreField​(java.lang.String value)
      Set the name of the output field for storing the per-entity scores for matching triggers.
      void setLastCompiled​(java.util.Date value)
      Set the time this dictionary was last compiled, or null if unknown.
      void setLastModified​(java.util.Date value)
      Set the time this dictionary was last modified, or null if unknown.
      void setLastPublished​(java.util.Date value)
      Set the time this dictionary was last published, or null if unknown.
      void setPublished​(boolean value)
      Set if all outstanding changes to this dictionary have been published.
      void setSchemaName​(java.lang.String value)
      Set the name of the schema to use for processing queries and documents.
      void setSynonymDictionary​(java.lang.String value)
      Set the name of the synonym dictionary to use for synonym expansion.
      void setTriggerNameField​(java.lang.String value)
      Set the name of the output field for storing the names of matching triggers.
      void setTriggerNameScopes​(boolean value)
      If true scopes will be added for trigger names for matching triggers.
      void setTriggerPayloadField​(java.lang.String value)
      Set the name of the output field that will contain payloads for matching triggers.
      void setTriggerScoreField​(java.lang.String value)
      Set the name of the output field for storing aggregate score for all matching triggers.
      void setTriggerVersionField​(java.lang.String value)
      Set the name of the output field that will contain a version identifer for the dictionary used to apply triggers.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_TRIGGER_NAME_FIELD

        public static final java.lang.String DEFAULT_TRIGGER_NAME_FIELD
        Default name for output field that contains the names of matching triggers.
        See Also:
        Constant Field Values

      • DEFAULT_TRIGGER_SCORE_FIELD

        public static final java.lang.String DEFAULT_TRIGGER_SCORE_FIELD
        Default name for trigger score output field.
        See Also:
        Constant Field Values

      • DEFAULT_ENTITY_NAME_FIELD

        public static final java.lang.String DEFAULT_ENTITY_NAME_FIELD
        Default name for output field that contains the entities for matching triggers.
        See Also:
        Constant Field Values

      • DEFAULT_TRIGGER_VERSION_FIELD

        public static final java.lang.String DEFAULT_TRIGGER_VERSION_FIELD
        Default name for the output field that contains the trigger dictionary's version number.
        See Also:
        Constant Field Values

      • DEFAULT_ENTITY_SCORE_FIELD

        public static final java.lang.String DEFAULT_ENTITY_SCORE_FIELD
        Default name for dynamic field that contains per-entity scores.
        See Also:
        Constant Field Values

      • lastModified

        public java.util.Date lastModified

      • lastCompiled

        public java.util.Date lastCompiled

      • lastPublished

        public java.util.Date lastPublished

    • Constructor Detail

      • TriggerDictionaryInfo

        public TriggerDictionaryInfo()

      • TriggerDictionaryInfo

        public TriggerDictionaryInfo​(java.lang.String name)

      • TriggerDictionaryInfo

        public TriggerDictionaryInfo​(java.lang.String namespace,
                             java.lang.String name)

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Get an optional description for this trigger dictionary.

      • setDescription

        public void setDescription​(java.lang.String value)
        Set an optional description for this trigger dictionary.

      • getSchemaName

        public java.lang.String getSchemaName()
        Get the name of the schema to use for processing queries and documents.

      • setSchemaName

        public void setSchemaName​(java.lang.String value)
        Set the name of the schema to use for processing queries and documents.

      • getSynonymDictionary

        public java.lang.String getSynonymDictionary()
        Get the name of the synonym dictionary to use for synonym expansion.

      • setSynonymDictionary

        public void setSynonymDictionary​(java.lang.String value)
        Set the name of the synonym dictionary to use for synonym expansion.

      • getLastModified

        public java.util.Date getLastModified()
        Get the time this dictionary was last modified, or null if unknown.

      • setLastModified

        public void setLastModified​(java.util.Date value)
        Set the time this dictionary was last modified, or null if unknown.

      • getLastCompiled

        public java.util.Date getLastCompiled()
        Get the time this dictionary was last compiled, or null if unknown.

      • setLastCompiled

        public void setLastCompiled​(java.util.Date value)
        Set the time this dictionary was last compiled, or null if unknown.

      • getLastPublished

        public java.util.Date getLastPublished()
        Get the time this dictionary was last published, or null if unknown.

      • setLastPublished

        public void setLastPublished​(java.util.Date value)
        Set the time this dictionary was last published, or null if unknown.

      • isCompiled

        public boolean isCompiled()
        Get if all outstanding changes to this dictionary have been compiled.

      • setCompiled

        public void setCompiled​(boolean value)
        Set if all outstanding changes to this dictionary have been compiled.

      • isPublished

        public boolean isPublished()
        Get if all outstanding changes to this dictionary have been published.

      • setPublished

        public void setPublished​(boolean value)
        Set if all outstanding changes to this dictionary have been published.

      • getTriggerPayloadField

        public java.lang.String getTriggerPayloadField()
        Get the name of the output field that will contain payloads for matching triggers.

      • setTriggerPayloadField

        public void setTriggerPayloadField​(java.lang.String value)
        Set the name of the output field that will contain payloads for matching triggers.

      • getTriggerVersionField

        public java.lang.String getTriggerVersionField()
        Get the name of the output field that will contain a version identifer for the dictionary used to apply triggers.

      • setTriggerVersionField

        public void setTriggerVersionField​(java.lang.String value)
        Set the name of the output field that will contain a version identifer for the dictionary used to apply triggers.

      • getTriggerNameField

        public java.lang.String getTriggerNameField()
        Get the name of the output field for storing the names of matching triggers.

        If this is the empty string, matching trigger names will not be output.

      • setTriggerNameField

        public void setTriggerNameField​(java.lang.String value)
        Set the name of the output field for storing the names of matching triggers.

        If this is the empty string, matching trigger names will not be output.

      • getTriggerScoreField

        public java.lang.String getTriggerScoreField()
        Get the name of the output field for storing aggregate score for all matching triggers.

        If this is the empty string, the aggregate trigger score will not be output.

      • setTriggerScoreField

        public void setTriggerScoreField​(java.lang.String value)
        Set the name of the output field for storing aggregate score for all matching triggers.

        If this is the empty string, the aggregate trigger score will not be output.

      • getEntityNameField

        public java.lang.String getEntityNameField()
        Get the name of the output field for storing the entity names for matching triggers.

        If this is the empty string, matching entity names will not be output.

      • setEntityNameField

        public void setEntityNameField​(java.lang.String value)
        Set the name of the output field for storing the entity names for matching triggers.

        If this is the empty string, matching entity names will not be output.

      • getEntityScoreField

        public java.lang.String getEntityScoreField()
        Get the name of the output field for storing the per-entity scores for matching triggers.

        If this is the empty string, per-entity scores will not be output.

        NOTE: This field must be a dynamic field (start with *).

      • setEntityScoreField

        public void setEntityScoreField​(java.lang.String value)
        Set the name of the output field for storing the per-entity scores for matching triggers.

        If this is the empty string, per-entity scores will not be output.

        NOTE: This field must be a dynamic field (start with *).

      • isTriggerNameScopes

        public boolean isTriggerNameScopes()
        If true scopes will be added for trigger names for matching triggers.

      • setTriggerNameScopes

        public void setTriggerNameScopes​(boolean value)
        If true scopes will be added for trigger names for matching triggers.

      • isEntityNameScopes

        public boolean isEntityNameScopes()
        If true scopes will be added for entity names for matching triggers.

      • setEntityNameScopes

        public void setEntityNameScopes​(boolean value)
        If true scopes will be added for entity names for matching triggers.