DocumentInfo
Inheritance: java.lang.Object
public abstract class DocumentInfo
Represents a descriptor for an indexed document.
Learn more
Constructors
| Constructor | Description |
|---|---|
| DocumentInfo() |
Methods
| Method | Description |
|---|---|
| toString() | Returns a System.String that represents the current DocumentInfo . |
| getFilePath() | Gets the file path for indexed from file or the document key for indexed from stream or structure. |
| getFileType() | Gets the file type. |
| getFormatFamily() | Gets the document format family. |
| getInnerPath() | Gets the inner path for the container document item. |
| getInnerPathParts() | Gets the inner path parts for the container document item. |
| getDocumentSourceKind() | Gets the document source kind. |
| getIndexedWithError() | Gets the indicator of indexing error. |
| serialize() | Serializes the current instance to a byte array. |
| deserialize(byte[] array) | Deserializes an instance from a byte array. |
DocumentInfo()
public DocumentInfo()
toString()
public abstract String toString()
Returns a System.String that represents the current DocumentInfo .
Returns: java.lang.String - A System.String that represents the current DocumentInfo .
getFilePath()
public abstract String getFilePath()
Gets the file path for indexed from file or the document key for indexed from stream or structure.
Returns: java.lang.String - The file path or document key.
getFileType()
public abstract FileType getFileType()
Gets the file type.
Returns: FileType - The file type.
getFormatFamily()
public abstract FormatFamily getFormatFamily()
Gets the document format family.
Returns: FormatFamily - The document format family.
getInnerPath()
public abstract String getInnerPath()
Gets the inner path for the container document item.
Returns: java.lang.String - The inner path.
getInnerPathParts()
public abstract String[] getInnerPathParts()
Gets the inner path parts for the container document item.
Returns: java.lang.String[] - The inner path parts.
getDocumentSourceKind()
public abstract DocumentSourceKind getDocumentSourceKind()
Gets the document source kind.
Returns: DocumentSourceKind - The document source kind.
getIndexedWithError()
public abstract boolean getIndexedWithError()
Gets the indicator of indexing error.
Returns: boolean - The indicator of indexing error.
serialize()
public abstract byte[] serialize()
Serializes the current instance to a byte array.
Returns: byte[] - A byte array representing the current instance.
deserialize(byte[] array)
public static DocumentInfo deserialize(byte[] array)
Deserializes an instance from a byte array.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| array | byte[] | A byte array to deserialize from. |
Returns: DocumentInfo - An instance deserialized from a byte array.