Class Intention

java.lang.Object
com.lexalytics.salience.Intention

public class Intention
extends java.lang.Object

An Intention object represents an intended action expressed in a document.

  • Constructor Summary

    Constructors 
    Constructor Description
    Intention​(java.lang.String sType, java.lang.String sWho, java.lang.String sWhat, java.lang.String sEvidence, Chunk oWho, Chunk oWhat, Chunk oEvidence)
    Creates a new intention.
  • Method Summary

    Modifier and Type Method Description
    java.lang.String getEvidence()
    Retrieves the evidence phrase of the intention.
    Chunk getEvidenceChunk()
    Retrieves the Chunk object relating to the evidence phrase of the intention
    java.lang.String getType()
    Retrieves the type of intention.
    java.lang.String getWhat()
    Retrieves what the object of the intention is.
    Chunk getWhatChunk()
    Retrieves the Chunk object relating to what the object of the intention is.
    java.lang.String getWho()
    Retrieves who expressed the intention
    Chunk getWhoChunk()
    Retrieves the Chunk object relating to who expressed the intention

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Intention

      public Intention​(java.lang.String sType, java.lang.String sWho, java.lang.String sWhat, java.lang.String sEvidence, Chunk oWho, Chunk oWhat, Chunk oEvidence)
      Creates a new intention. This is not intended for client use. Intention are created by Salience Engine when a Salience.getDocumentIntentions() API method is called.
      Parameters:
      sType - The type of intention being expressed.
      sWho - Who expressed the intention.
      sWhat - What is the object of this intention.
      sEvidence - What phrase implied this intention.
      oWho - The Chunk object relating to who expressed the intention.
      oWhat - The Chunk object relating to what the object of this intention is.
      oEvidence - The Chunk object relating to the phrase that implied this intention.
  • Method Details

    • getType

      public java.lang.String getType()
      Retrieves the type of intention.
      Returns:
      The type of intention this is.
    • getWho

      public java.lang.String getWho()
      Retrieves who expressed the intention
      Returns:
      The individual expressing this intention.
    • getWhat

      public java.lang.String getWhat()
      Retrieves what the object of the intention is.
      Returns:
      The object of the intention.
    • getEvidence

      public java.lang.String getEvidence()
      Retrieves the evidence phrase of the intention.
      Returns:
      The evidence phrase of the intention.
    • getWhoChunk

      public Chunk getWhoChunk()
      Retrieves the Chunk object relating to who expressed the intention
      Returns:
      The Chunk object relating to the individual expressing this intention.
    • getWhatChunk

      public Chunk getWhatChunk()
      Retrieves the Chunk object relating to what the object of the intention is.
      Returns:
      The Chunk object relating to what the object of the intention is.
    • getEvidenceChunk

      public Chunk getEvidenceChunk()
      Retrieves the Chunk object relating to the evidence phrase of the intention
      Returns:
      The Chunk object relating to the evidence phrase of the intention.