com.groupdocs.metadata.core

Class XmpPacketWrapper

java.lang.Object

com.groupdocs.metadata.core.MetadataPackage

com.groupdocs.metadata.core.XmpPacketWrapper

All Implemented Interfaces:

IXmpType, Iterable<MetadataProperty>

public class XmpPacketWrapper
extends MetadataPackage
implements IXmpType

Contains serialized XMP package including header and trailer. A wrapper consisting of a pair of XML processing instructions (PIs) may be placed around the rdf:RDF element.

Learn more

• Working with XMP metadata

Constructor Summary

Constructors

Constructor and Description
XmpPacketWrapper() Initializes a new instance of the XmpPacketWrapper class.
XmpPacketWrapper(XmpHeaderPI header, XmpTrailerPI trailer, XmpMeta xmpMeta) Initializes a new instance of the XmpPacketWrapper class.

Method Summary

Modifier and Type	Method and Description
void	addPackage(XmpPackage package_) Adds the package.
void	clearPackages() Removes all XmpPackage inside XMP.
boolean	containsPackage(String namespaceUri) Determines whether package is exist in XMP wrapper.
XmpHeaderPI	getHeaderPI() Gets the header processing instruction.
XmpMeta	getMeta() Gets the XMP meta.
XmpPackage	getPackage(String namespaceUri) Gets package by namespace uri.
int	getPackageCount() Gets the number of packages inside the XMP structure.
XmpPackage[]	getPackages() Gets array of XmpPackage inside XMP.
XmpSchemes	getSchemes() Provides access to known XMP schemas.
XmpTrailerPI	getTrailerPI() Gets the trailer processing instruction.
String	getXmpRepresentation() Returns string contained value in XMP format.
void	removePackage(XmpPackage package_) Removes the specified package.
void	setHeaderPI(XmpHeaderPI value) Sets the header processing instruction.
void	setMeta(XmpMeta value) Sets the XMP meta.
void	setTrailerPI(XmpTrailerPI value) Sets the trailer processing instruction.

Methods inherited from class com.groupdocs.metadata.core.MetadataPackage

addProperties, contains, findProperties, get_Item, getCount, getKeys, getKnowPropertyDescriptors, getMetadataType, getPropertyDescriptors, iterator, removeProperties, sanitize, setProperties, updateProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

XmpPacketWrapper

public XmpPacketWrapper()

Initializes a new instance of the XmpPacketWrapper class.

XmpPacketWrapper

public XmpPacketWrapper(XmpHeaderPI header,
                        XmpTrailerPI trailer,
                        XmpMeta xmpMeta)

Initializes a new instance of the XmpPacketWrapper class.

Parameters:

header - XMP header processing instruction.

trailer - XMP trailer processing instruction.

xmpMeta - Instance of XmpMeta.

Method Detail

addPackage

public final void addPackage(XmpPackage package_)

Adds the package.

Parameters:

package - The package.

clearPackages

public final void clearPackages()

Removes all XmpPackage inside XMP.

containsPackage

public final boolean containsPackage(String namespaceUri)

Determines whether package is exist in XMP wrapper.

Parameters:

namespaceUri - Package namespace URI.

Returns:

true if package found by namespaceUri; otherwise false.

Throws:

com.aspose.ms.System.ArgumentNullException - Namespace URI could not be null.

getHeaderPI

public final XmpHeaderPI getHeaderPI()

Gets the header processing instruction.

Returns:

The header processing instruction.

getMeta

public final XmpMeta getMeta()

Gets the XMP meta.

Returns:

The XMP meta.

getPackage

public final XmpPackage getPackage(String namespaceUri)

Gets package by namespace uri.

Parameters:

namespaceUri - Package schema uri.

Returns:

Appropriate XmpPackage if package found by namespaceUri; otherwise null.

Throws:

com.aspose.ms.System.ArgumentNullException - Namespace URI could not be null.

getPackageCount

public final int getPackageCount()

Gets the number of packages inside the XMP structure.

Returns:

The package count.

getPackages

public final XmpPackage[] getPackages()

Gets array of XmpPackage inside XMP.

Returns:

XMP packages.

getSchemes

public final XmpSchemes getSchemes()

Provides access to known XMP schemas.

Returns:

XMP schemes.

getTrailerPI

public final XmpTrailerPI getTrailerPI()

Gets the trailer processing instruction.

Returns:

The trailer processing instruction.

getXmpRepresentation

public final String getXmpRepresentation()

Returns string contained value in XMP format.

Specified by:

getXmpRepresentation in interface IXmpType

Returns:

string contained XMP representation.

removePackage

public final void removePackage(XmpPackage package_)

Removes the specified package.

Parameters:

package - The package.

setHeaderPI

public final void setHeaderPI(XmpHeaderPI value)

Sets the header processing instruction.

Parameters:

value - The header processing instruction.

setMeta

public final void setMeta(XmpMeta value)

Sets the XMP meta.

Parameters:

value - The XMP meta.

setTrailerPI

public final void setTrailerPI(XmpTrailerPI value)

Sets the trailer processing instruction.

Parameters:

value - The trailer processing instruction.