com.groupdocs.search.results

Constructor Detail

• FoundDocument

  protected FoundDocument(DocumentInfo documentInfo,
                          double relevance,
                          int occurrenceCount,
                          FoundDocumentField[] detailedResults,
                          String[][] termSequences,
                          boolean isCaseSensitive)

  Initializes a new instance of the FoundDocument class.

  Parameters:

  documentInfo - The document information.

  relevance - The relevance.

  occurrenceCount - The occurrence count.

  detailedResults - The detailed results.

  termSequences - The term sequences.

  isCaseSensitive - The case sensitivity flag.

Method Detail

• create

  protected static FoundDocument create(DocumentInfo documentInfo,
                                        double relevance,
                                        int occurrenceCount,
                                        FoundDocumentField[] detailedResults,
                                        String[][] termSequences,
                                        boolean isCaseSensitive)

• getDocumentInfo

  public final DocumentInfo getDocumentInfo()

  Gets the document info.

  Returns:

  The document info.

• getRelevance

  public final double getRelevance()

  Gets the relevance of search result.

  Returns:

  The relevance of search result.

• getOccurrenceCount

  public final int getOccurrenceCount()

  Gets the number of occurrences found.

  Returns:

  The number of occurrences found.

• getFoundFields

  public final FoundDocumentField[] getFoundFields()

  Gets the document fields found.

  Returns:

  The document fields found.

• getTerms

  public final String[] getTerms()

  Gets the terms found. The value is evaluated each time the property is accessed.

  Returns:

  The terms found.

• getTermSequences

  public final String[][] getTermSequences()

  Gets the term sequences found.

  Returns:

  The term sequences found.

• toString

  public String toString()

  Returns string representation of the found document.

  Overrides:

  toString in class Object

  Returns:

  A string that represents the found document.

• serialize

  public final byte[] serialize()

  Serializes the current instance to a byte array.

  Returns:

  A byte array representing the current instance.

• deserialize

  public static FoundDocument deserialize(byte[] array)

  Deserializes an instance from a byte array.

  Parameters:

  array - A byte array to deserialize from.

  Returns:

  An instance deserialized from a byte array.

• isCaseSensitive

  protected static boolean isCaseSensitive(FoundDocument foundDocument)

• adjustRelevance

  protected static void adjustRelevance(FoundDocument foundDocument,
                                        double additionalRelevance)