XmpPacketWrapper

Inheritance: java.lang.Object, com.groupdocs.metadata.core.MetadataPackage

All Implemented Interfaces: com.groupdocs.metadata.core.IXmpType

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

Constructors

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

Methods

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

XmpPacketWrapper(XmpHeaderPI header, XmpTrailerPI trailer, XmpMeta xmpMeta)

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

Initializes a new instance of the XmpPacketWrapper class.

Parameters:

Parameter Type Description
header XmpHeaderPI XMP header processing instruction.
trailer XmpTrailerPI XMP trailer processing instruction.
xmpMeta XmpMeta Instance of XmpMeta .

XmpPacketWrapper()

public XmpPacketWrapper()

Initializes a new instance of the XmpPacketWrapper class.

getHeaderPI()

public final XmpHeaderPI getHeaderPI()

Gets the header processing instruction.

Returns: XmpHeaderPI - The header processing instruction.

setHeaderPI(XmpHeaderPI value)

public final void setHeaderPI(XmpHeaderPI value)

Sets the header processing instruction.

Parameters:

Parameter Type Description
value XmpHeaderPI The header processing instruction.

getMeta()

public final XmpMeta getMeta()

Gets the XMP meta.

Returns: XmpMeta - The XMP meta.

setMeta(XmpMeta value)

public final void setMeta(XmpMeta value)

Sets the XMP meta.

Parameters:

Parameter Type Description
value XmpMeta The XMP meta.

getTrailerPI()

public final XmpTrailerPI getTrailerPI()

Gets the trailer processing instruction.

Returns: XmpTrailerPI - The trailer processing instruction.

setTrailerPI(XmpTrailerPI value)

public final void setTrailerPI(XmpTrailerPI value)

Sets the trailer processing instruction.

Parameters:

Parameter Type Description
value XmpTrailerPI The trailer processing instruction.

getPackages()

public final XmpPackage[] getPackages()

Gets array of XmpPackage inside XMP.

Returns: com.groupdocs.metadata.core.XmpPackage[] - XMP packages.

getPackageCount()

public final int getPackageCount()

Gets the number of packages inside the XMP structure.

Returns: int - The package count.

getSchemes()

public final XmpSchemes getSchemes()

Provides access to known XMP schemas.

Returns: XmpSchemes - XMP schemes.

addPackage(XmpPackage package_)

public final void addPackage(XmpPackage package_)

Adds the package.

Parameters:

Parameter Type Description
package_ XmpPackage

getPackage(String namespaceUri)

public final XmpPackage getPackage(String namespaceUri)

Gets package by namespace uri.

Parameters:

Parameter Type Description
namespaceUri java.lang.String Package schema uri.

Returns: XmpPackage - Appropriate XmpPackage if package found by namespaceUri ; otherwise null.

containsPackage(String namespaceUri)

public final boolean containsPackage(String namespaceUri)

Determines whether package is exist in XMP wrapper.

Parameters:

Parameter Type Description
namespaceUri java.lang.String Package namespace URI.

Returns: boolean - true if package found by namespaceUri ; otherwise false .

removePackage(XmpPackage package_)

public final void removePackage(XmpPackage package_)

Removes the specified package.

Parameters:

Parameter Type Description
package_ XmpPackage

clearPackages()

public final void clearPackages()

Removes all XmpPackage inside XMP.

getXmpRepresentation()

public final String getXmpRepresentation()

Returns string contained value in XMP format.

Returns: java.lang.String - string contained XMP representation.