com.groupdocs.search.results

Class DocumentInfo

java.lang.Object

com.groupdocs.search.results.DocumentInfo

public abstract class DocumentInfo
extends Object

Represents a descriptor for an indexed document.

Learn more

• Search results
• Getting indexed documents

Constructor Summary

Constructors

Constructor and Description
DocumentInfo()

Method Summary

Modifier and Type	Method and Description
static DocumentInfo	deserialize(byte[] array) Deserializes an instance from a byte array.
abstract DocumentSourceKind	getDocumentSourceKind() Gets the document source kind.
abstract String	getFilePath() Gets the file path for indexed from file or the document key for indexed from stream or structure.
abstract FileType	getFileType() Gets the file type.
abstract FormatFamily	getFormatFamily() Gets the document format family.
abstract boolean	getIndexedWithError() Gets the indicator of indexing error.
abstract String	getInnerPath() Gets the inner path for the container document item.
abstract String[]	getInnerPathParts() Gets the inner path parts for the container document item.
abstract byte[]	serialize() Serializes the current instance to a byte array.
abstract String	toString() Returns a System.String that represents the current DocumentInfo.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentInfo

public DocumentInfo()

Method Detail

deserialize

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

getDocumentSourceKind

public abstract DocumentSourceKind getDocumentSourceKind()

Gets the document source kind.

Returns:

The document source kind.

getFilePath

public abstract String getFilePath()

Gets the file path for indexed from file or the document key for indexed from stream or structure.

Returns:

The file path or document key.

getFileType

public abstract FileType getFileType()

Gets the file type.

Returns:

The file type.

getFormatFamily

public abstract FormatFamily getFormatFamily()

Gets the document format family.

Returns:

The document format family.

getIndexedWithError

public abstract boolean getIndexedWithError()

Gets the indicator of indexing error.

Returns:

The indicator of indexing error.

getInnerPath

public abstract String getInnerPath()

Gets the inner path for the container document item.

Returns:

The inner path.

getInnerPathParts

public abstract String[] getInnerPathParts()

Gets the inner path parts for the container document item.

Returns:

The inner path parts.

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 a System.String that represents the current DocumentInfo.

Overrides:

toString in class Object

Returns:

A System.String that represents the current DocumentInfo.