com.groupdocs.search.results

Class FoundDocument

java.lang.Object

com.groupdocs.search.results.FoundDocument

public abstract class FoundDocument
extends Object

Represents a found document.

Learn more

• Search results

Constructor Summary

Constructors

Constructor and Description
FoundDocument()

Method Summary

Modifier and Type	Method and Description
static FoundDocument	deserialize(byte[] array) Deserializes an instance from a byte array.
abstract String[]	getAttributes() Gets the attributes associated with the found document.
abstract DocumentInfo	getDocumentInfo() Gets the document info.
abstract FoundDocumentField[]	getFoundFields() Gets the document fields found.
abstract int	getOccurrenceCount() Gets the number of occurrences found.
abstract double	getRelevance() Gets the relevance of search result.
abstract String[]	getTerms() Gets the terms found.
abstract String[][]	getTermSequences() Gets the term sequences found.
abstract byte[]	serialize() Serializes the current instance to a byte array.
abstract String	toString() Returns string representation of the found document.

Methods inherited from class java.lang.Object

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

Constructor Detail

FoundDocument

public FoundDocument()

Method Detail

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.

getAttributes

public abstract String[] getAttributes()

Gets the attributes associated with the found document. The corresponding option must be enabled in the search options to retrieve attributes.

Returns:

The attributes associated with the found document.

getDocumentInfo

public abstract DocumentInfo getDocumentInfo()

Gets the document info.

Returns:

The document info.

getFoundFields

public abstract FoundDocumentField[] getFoundFields()

Gets the document fields found.

Returns:

The document fields found.

getOccurrenceCount

public abstract int getOccurrenceCount()

Gets the number of occurrences found.

Returns:

The number of occurrences found.

getRelevance

public abstract double getRelevance()

Gets the relevance of search result.

Returns:

The relevance of search result.

getTerms

public abstract String[] getTerms()

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

Returns:

The terms found.

getTermSequences

public abstract String[][] getTermSequences()

Gets the term sequences found.

Returns:

The term sequences found.

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.

Overrides:

toString in class Object

Returns:

A string that represents the found document.