com.groupdocs.search.results

Class FoundDocumentField

java.lang.Object

com.groupdocs.search.results.FoundDocumentField

public abstract class FoundDocumentField
extends Object

Represents a found document field.

Learn more

• Search results

Constructor Summary

Constructors

Constructor and Description
FoundDocumentField()

Method Summary

Modifier and Type	Method and Description
static FoundDocumentField	deserialize(byte[] array) Deserializes an instance from a byte array.
abstract String	getFieldName() Gets the field name.
abstract int	getOccurrenceCount() Gets the number of occurrences found.
abstract String[]	getTerms() Gets the terms found.
abstract String[][]	getTermSequences() Gets the term sequences found.
abstract int[]	getTermSequencesOccurrences() Gets the occurrences of the found term sequences.
abstract int[]	getTermsOccurrences() Gets the occurrences of the found terms.
abstract byte[]	serialize() Serializes the current instance to a byte array.
abstract String	toString() Returns string representation of the found document field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FoundDocumentField

public FoundDocumentField()

Method Detail

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.

getFieldName

public abstract String getFieldName()

Gets the field name.

Returns:

The field name.

getOccurrenceCount

public abstract int getOccurrenceCount()

Gets the number of occurrences found.

Returns:

The number of occurrences found.

getTerms

public abstract String[] getTerms()

Gets the terms found.

Returns:

The terms found.

getTermSequences

public abstract String[][] getTermSequences()

Gets the term sequences found.

Returns:

The term sequences found.

getTermSequencesOccurrences

public abstract int[] getTermSequencesOccurrences()

Gets the occurrences of the found term sequences.

Returns:

The occurrences of the found term sequences.

getTermsOccurrences

public abstract int[] getTermsOccurrences()

Gets the occurrences of the found terms.

Returns:

The occurrences of the found terms.

serialize

public abstract byte[] serialize()

Serializes the current instance to a byte array.

Returns:

A byte array representing the current instance.

toString

public abstract String toString()

Returns string representation of the found document field.

Overrides:

toString in class Object

Returns:

A string that represents the found document field.