public abstract class DocumentFormat<T extends DocumentMetadata<TK>,TK extends MetadataProperty,DI extends DocumentInfo> extends FormatBase implements IDocumentFormat
Represents base abstraction for document formats such as PDF, WORD, EXCEL, PowerPoint.
T
: Represents DocumentMetadata{TK}
.
TK
: Represents MetadataProperty
.
DI
: Represents DocumentInfo
.
filePath, stream
Modifier | Constructor and Description |
---|---|
protected |
DocumentFormat(InputStream input)
Initializes a new instance of the
DocumentFormat{T,TK, DI} class. |
protected |
DocumentFormat(String fileName)
Initializes a new instance of the
DocumentFormat{T,TK, DI} class. |
Modifier and Type | Method and Description |
---|---|
void |
clearBuiltInProperties()
Resets built-in properties.
|
void |
clearCustomProperties()
Removes all custom document properties.
|
MetadataPropertyCollection |
extractDocumentProperties()
Extracts the document properties.
|
DI |
getDocumentInfo()
Gets the document calculated info.
|
T |
getDocumentProperties()
Gets document properties
T presented in DocumentFormat{T,TK,DI} . |
int |
getFileType()
Gets the file type.
|
byte[] |
getThumbnail()
Gets the thumbnail of document in PNG format.
|
MetadataProperty |
readDocumentPropertyByKey(MetadataKey key) |
MetadataProperty |
readPropertyByName(String propertyName) |
int |
setProperties(MetadataPropertyCollection properties)
Updates document properties.
|
cleanMetadata, dispose, getMetadata, getMIMEType, getType, readByMetadataKey, save, save, save
protected DocumentFormat(String fileName)
Initializes a new instance of the DocumentFormat{T,TK, DI}
class.
fileName
- Absolute path to the file.protected DocumentFormat(InputStream input)
Initializes a new instance of the DocumentFormat{T,TK, DI}
class.
input
- File stream.public T getDocumentProperties()
Gets document properties T
presented in DocumentFormat{T,TK,DI}
.
public int getFileType()
Gets the file type.
Value: File file.public final DI getDocumentInfo()
Gets the document calculated info.
Value: The document information.public final byte[] getThumbnail()
Gets the thumbnail of document in PNG format. Thumbnail is provided only for first page in document.
com.aspose.ms.System.NotSupportedException
- Reading of thumbnail is not supported for PptFormat.GroupDocsException
- Could not read thumbnail.
Value:
The thumbnail.
public final MetadataPropertyCollection extractDocumentProperties()
Extracts the document properties.
extractDocumentProperties
in interface IDocumentFormat
MetadataPropertyCollection
public final int setProperties(MetadataPropertyCollection properties)
Updates document properties.
setProperties
in interface IDocumentFormat
properties
- Document properties.
com.aspose.ms.System.ArgumentNullException
- Properties could not be null.public void clearBuiltInProperties()
Resets built-in properties.
public void clearCustomProperties()
Removes all custom document properties.
public MetadataProperty readPropertyByName(String propertyName)
public MetadataProperty readDocumentPropertyByKey(MetadataKey key)
Copyright © 2017. All rights reserved.