Package com.attivio.sdk.client.trigger

Class TriggerDefinition

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class TriggerDefinition
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
    Defines a trigger, which is used for matching documents during ingestion processing.

    A trigger is uniquely identified in a dictionary by its name.

    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addEntity​(java.lang.String entity, Query query)
      Add an additional entity to extract.
      TriggerDefinition clone()  
      boolean equals​(java.lang.Object other)  
      java.util.Map<java.lang.String,​Query> getEntities()
      Get additional entities to extract.
      java.lang.String getEntity()
      Get the entity name for this trigger.
      java.util.Date getLastModified()
      Get the time this trigger was last modified, or null if unknown.
      java.util.Locale getLocale()
      Get the Locale to use for evaluating this trigger.
      java.lang.String getName()
      Get the name of this trigger.
      java.lang.String getPayload()
      Get the payload for this trigger.
      Query getQuery()
      Get the query to use for matching this trigger.
      int getScore()
      Get the score for matching this trigger.
      int hashCode()  
      boolean isCompiled()
      Get if the most recent modification for this trigger has been compiled.
      boolean isPublished()
      Get if the most recent modification for this trigger has been published.
      void setCompiled​(boolean value)
      Get if the most recent modification for this trigger has been compiled.
      void setEntities​(java.util.Map<java.lang.String,​Query> value)
      Set additional entities to extract.
      void setEntity​(java.lang.String value)
      Set the entity name for this trigger.
      void setLastModified​(java.util.Date value)
      Set the time this trigger was last modified, or null if unknown.
      void setLocale​(java.util.Locale value)
      Set the Locale to use for evaluating this trigger.
      void setName​(java.lang.String value)
      Set the name of this trigger.
      void setPayload​(java.lang.String value)
      Set the payload for this trigger.
      void setPublished​(boolean value)
      Get if the most recent modification for this trigger has been published.
      void setQuery​(Query value)
      Set the query to use for matching this trigger.
      void setScore​(int value)
      Set the score for matching this trigger.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TriggerDefinition

        public TriggerDefinition()

      • TriggerDefinition

        public TriggerDefinition​(java.lang.String name)

      • TriggerDefinition

        public TriggerDefinition​(java.lang.String name,
                         java.util.Locale locale)

    • Method Detail

      • getName

        public java.lang.String getName()
        Get the name of this trigger.

      • setName

        public void setName​(java.lang.String value)
        Set the name of this trigger.

      • getLastModified

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

      • setLastModified

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

      • getEntity

        public java.lang.String getEntity()
        Get the entity name for this trigger.

      • setEntity

        public void setEntity​(java.lang.String value)
        Set the entity name for this trigger.

      • getEntities

        public java.util.Map<java.lang.String,​Query> getEntities()
        Get additional entities to extract.

        These entities will not affect the match for this trigger and will not contribute any score, but will be used for annotating entities if this trigger matches.

      • setEntities

        public void setEntities​(java.util.Map<java.lang.String,​Query> value)
        Set additional entities to extract.

        These entities will not affect the match for this trigger and will not contribute any score, but will be used for annotating entities if this trigger matches.

      • addEntity

        public void addEntity​(java.lang.String entity,
                      Query query)
        Add an additional entity to extract.

        These entities will not affect the match for this trigger and will not contribute any score, but will be used for annotating entities if this trigger matches.

      • getPayload

        public java.lang.String getPayload()
        Get the payload for this trigger.

      • setPayload

        public void setPayload​(java.lang.String value)
        Set the payload for this trigger.

      • getScore

        public int getScore()
        Get the score for matching this trigger.

      • setScore

        public void setScore​(int value)
        Set the score for matching this trigger.

      • getQuery

        public Query getQuery()
        Get the query to use for matching this trigger.

      • setQuery

        public void setQuery​(Query value)
        Set the query to use for matching this trigger.

      • getLocale

        public java.util.Locale getLocale()
        Get the Locale to use for evaluating this trigger.

      • setLocale

        public void setLocale​(java.util.Locale value)
        Set the Locale to use for evaluating this trigger.

      • isCompiled

        public boolean isCompiled()
        Get if the most recent modification for this trigger has been compiled.

      • setCompiled

        public void setCompiled​(boolean value)
        Get if the most recent modification for this trigger has been compiled.

      • isPublished

        public boolean isPublished()
        Get if the most recent modification for this trigger has been published.

      • setPublished

        public void setPublished​(boolean value)
        Get if the most recent modification for this trigger has been published.

      • 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 TriggerDefinition clone()
        Overrides:
        clone in class java.lang.Object