com.groupdocs.search.results

Constructor Detail

• DocumentInfo

  protected DocumentInfo(String filePath,
                         FileType fileType,
                         String[] innerPathParts,
                         int[] partIds,
                         DocumentSourceKind documentSourceKind,
                         boolean indexedWithError)

  Initializes a new instance of the DocumentInfo class.

  Parameters:

  filePath - The file path.

  fileType - The file type

  innerPathParts - The path parts.

  partIds - The part IDs.

  documentSourceKind - The document source kind.

  indexedWithError - The indexed with error flag.

Method Detail

• create

  protected static DocumentInfo create(String filePath,
                                       FileType fileType,
                                       String[] innerPathParts,
                                       int[] partIds,
                                       DocumentSourceKind documentSourceKind,
                                       boolean indexedWithError)

• toString

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

• getFilePath

  public final 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 final FileType getFileType()

  Gets the file type.

  Returns:

  The file type.

• getFormatFamily

  public final FormatFamily getFormatFamily()

  Gets the document format family.

  Returns:

  The document format family.

• getInnerPath

  public final String getInnerPath()

  Gets the inner path for the container document item.

  Returns:

  The inner path.

• getInnerPathParts

  public final String[] getInnerPathParts()

  Gets the inner path parts for the container document item.

  Returns:

  The inner path parts.

• getDocumentSourceKind

  public final DocumentSourceKind getDocumentSourceKind()

  Gets the document source kind.

  Returns:

  The document source kind.

• getIndexedWithError

  public final boolean getIndexedWithError()

  Gets the indicator of indexing error.

  Returns:

  The indicator of indexing error.

• serialize

  public final byte[] serialize()

  Serializes the current instance to a byte array.

  Returns:

  A byte array representing the current instance.

• 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.

• getPartIds

  protected static final int[] getPartIds(DocumentInfo info)

• getDocumentSourceKind

  protected static final DocumentSourceKind getDocumentSourceKind(DocumentInfo info)

• toFoundDocument

  protected static final FoundDocument toFoundDocument(DocumentInfo info)