Fb2Package class
Fb2Package class
Represents metadata in a Fb2 e-book.
Inheritance: Fb2Package →
CustomPackage →
MetadataPackage
The Fb2Package type exposes the following members:
Properties
| Property | Description |
|---|---|
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| title_info | Description of information about the work (including translation, but excluding publication). |
| src_title_info | Description of information about the work in the original language (not available for the original book). |
| document_info | Description of information about a specific FB2.x document (creator(s), history, etc.). |
| publish_info | Information about the paper (or other) publication on the basis of which the FB2.x document was created. It is not recommended to fill in data from an arbitrary publication if the source is unknown, except for the case when verification was carried out on it and the document was brought to the form of this publication. If the source is unknown, it is better to omit this element altogether. |
| custom_info | Some information about the document that is not provided in the rest of the description. This may be either just some information from the author or some information that may be useful to some FB2 software. |
Methods
| Method | Description |
|---|---|
contains(self, property_name) |
Determines whether the package contains a metadata property with the specified name. |
find_properties(self, specification) |
Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well. |
update_properties(self, specification, value) |
Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well. |
remove_properties(self, specification) |
Removes metadata properties satisfying a specification. |
add_properties(self, specification, value) |
Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well. |
set_properties(self, specification, value) |
Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well. This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package. |
sanitize(self) |
Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well. |
Remarks
Learn more | | |
See Also
- module
groupdocs.metadata.formats.fb2 - class
CustomPackage - class
Fb2Package - class
MetadataPackage