Class Summary

java.lang.Object
com.lexalytics.salience.Summary

public class Summary
extends java.lang.Object

The Summary object provides a brief summary about the document content determined by Salience. This includes both a string of the summary as well as an object of the individual sentences.

  • Constructor Summary

    Constructors 
    Constructor Description
    Summary​(java.lang.String sSummary, java.util.Vector<Sentence> vSentences, java.lang.String sAlternateSummary, java.util.Vector<Sentence> vAlternateSentences)
    Creates a new Summary object.
  • Method Summary

    Modifier and Type Method Description
    java.util.Vector<Sentence> getAlternateSentences()
    Retrieves the sentences of the alternate summary of the document.
    java.lang.String getAlternateText()
    Retrieves the alternate summary of the document.
    java.util.Vector<Sentence> getSentences()
    Retrieves the sentences of the summary of the document.
    java.lang.String getText()
    Retrieves the summary of the document.

    Methods inherited from class java.lang.Object

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

    • Summary

      public Summary​(java.lang.String sSummary, java.util.Vector<Sentence> vSentences, java.lang.String sAlternateSummary, java.util.Vector<Sentence> vAlternateSentences)
      Creates a new Summary object. This is not intended for client use, these objects are created by Salience Engine when calls to the Salience.getSummary(int) API method is called.
      Parameters:
      sSummary - The summary of the document.
      vSentences - The sentences of the summary.
      sAlternateSummary - The alternate summary of the document.
      vAlternateSentences - The sentences of the alternate summary.
  • Method Details

    • getText

      public final java.lang.String getText()
      Retrieves the summary of the document.
      Returns:
      A String containing the summary of the document.
    • getSentences

      public java.util.Vector<Sentence> getSentences()
      Retrieves the sentences of the summary of the document.
      Returns:
      A Vector of Sentence objects for the summary.
    • getAlternateText

      public final java.lang.String getAlternateText()
      Retrieves the alternate summary of the document.
      Returns:
      A String containing the alternate summary of the document.
    • getAlternateSentences

      public java.util.Vector<Sentence> getAlternateSentences()
      Retrieves the sentences of the alternate summary of the document.
      Returns:
      A Vector of Sentence objects for the summary.