Skip navigation links
com.groupdocs.search.results

Class FoundDocumentField


  • public class FoundDocumentField
extends Object
    Represents a found document field.

    Learn more

    • Constructor Detail

      • FoundDocumentField

        protected FoundDocumentField(String fieldName,
                             int occurrenceCount,
                             double relevance,
                             String[] terms,
                             int[] termsOccurrences,
                             String[][] termSequences,
                             int[] termSequencesOccurrences,
                             int[][] termSequencePositions)

        Initializes a new instance of the FoundDocumentField class.

        Parameters:
        fieldName - The field name.
        occurrenceCount - The occurrence count.
        relevance - The relevance.
        terms - The found terms.
        termsOccurrences - The found terms occurrences.
        termSequences - The found term sequences.
        termSequencesOccurrences - The occurrences of the found term sequences.
        termSequencePositions - The found term sequence positions.

    • Method Detail

      • getFieldName

        public final String getFieldName()

        Gets the field name.

        Returns:
        The field name.

      • getOccurrenceCount

        public final int getOccurrenceCount()

        Gets the number of occurrences found.

        Returns:
        The number of occurrences found.

      • getTerms

        public final String[] getTerms()

        Gets the terms found.

        Returns:
        The terms found.

      • getTermsOccurrences

        public final int[] getTermsOccurrences()

        Gets the occurrences of the found terms.

        Returns:
        The occurrences of the found terms.

      • getTermSequences

        public final String[][] getTermSequences()

        Gets the term sequences found.

        Returns:
        The term sequences found.

      • getTermSequencesOccurrences

        public final int[] getTermSequencesOccurrences()

        Gets the occurrences of the found term sequences.

        Returns:
        The occurrences of the found term sequences.

      • toString

        public String toString()

        Returns string representation of the found document field.

        Overrides:
        toString in class Object
        Returns:
        A string that represents the found document field.

      • getTermSequencePositions

        public final int[][] getTermSequencePositions()

        Gets the found term sequence positions.

        Returns:
        The found term sequence positions.

      • serialize

        public final byte[] serialize()

        Serializes the current instance to a byte array.

        Returns:
        A byte array representing the current instance.

      • deserialize

        public static FoundDocumentField 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.

      • create

        protected static FoundDocumentField create(String fieldName,
                                           int occurrenceCount,
                                           double relevance,
                                           String[] terms,
                                           int[] termsOccurrences,
                                           String[][] termSequences,
                                           int[] termSequencesOccurrences,
                                           int[][] termSequencePositions)