Packages

com.aspose.pdf.facades

Interfaces

Classes

java.lang.Object
- com.aspose.pdf.facades.Facade
- - com.aspose.pdf.facades.SaveableFacade
  - - com.aspose.pdf.facades.PdfXmpMetadata

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>, com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>, com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>, com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>, com.aspose.ms.System.IDisposable, IFacade, ISaveableFacade, Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
```
public final class PdfXmpMetadata
extends SaveableFacade
implements com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>
```
Class for manipulation with XMP metadata.

Constructor Summary

Constructors
Constructor and Description
`PdfXmpMetadata()` Constructor for PdfXmpMetadata.
`PdfXmpMetadata(IDocument document)` Initializes new `PdfXmpMetadata` object on base of the `document`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(XmpPdfAExtensionObject xmpPdfAExtensionObject, String namespacePrefix, String namespaceUri, String schemaDescription)` Adds extension field into metadata.
`void`	`addItem(int key, XmpValue value)` Adds value to XMP metadata.
`void`	`addItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue> item)` Adds pair with key and value into the dictionary.
`void`	`addItem(String key, Object value)` Adds new element to the dictionary object.
`void`	`addItem(String key, XmpValue value)` Adds new element to the dictionary object.
`void`	`clear()` Removes all elements from the object.
`boolean`	`contains(int property)` Checks if dictionary contains the specified property.
`boolean`	`contains(String key)` Checks if dictionary contains the specified key.
`boolean`	`containsItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue> item)` Checks does specified key-value pair is contained in the dictionary.
`boolean`	`containsKey(String key)` Determines does this dictionary contasins specified key.
`void`	`copyToTArray(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>[] array, int index)` Copy metadata into array.
`XmpValue`	`get_Item(String key)` Gets value by key.
`XmpValue`	`getByDefaultMetadataProperties(int key)` Gets value of XMP metadata by key.
`Hashtable<String,XmpPdfAExtensionSchema>`	`getExtensionFields()` Gets the dictionary of extension fields.
`com.aspose.ms.System.Collections.Generic.IGenericCollection<String>`	`getKeys()` Gets keys from the dictionary.
`String`	`getNamespaceURIByPrefix(String prefix)` Gets namespace URI by prefix.
`String`	`getPrefixByNamespaceURI(String namespaceURI)` Gets the prefix by namespace URI.
`Object`	`getSyncRoot()` Gets synchroniztion object of the collection.
`com.aspose.ms.System.Collections.Generic.IGenericCollection<XmpValue>`	`getValues()` Gets the collection of values in dictionary.
`byte[]`	`getXmpMetadata()` Get the XmpMetadata of the input pdf in a xml format.
`byte[]`	`getXmpMetadata(String name)` Get a part of the XmpMetadata of the input pdf according to a meta name.
`boolean`	`isFixedSize()` Returns true is collection has fixed size.
`boolean`	`isReadOnly()` Returns true if collection is read-only.
`boolean`	`isSynchronized()` Returns true if collection is synchronized.
`com.aspose.ms.System.Collections.IEnumerator`	`iterator_Rename_Namesake()`
`com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>`	`iterator()` Gets enumerator object of the dictionary.
`com.aspose.ms.System.Collections.IEnumerator`	`iteratorIt()` Gets enumerator object of the collection.
`void`	`registerNamespaceURI(String prefix, String namespaceURI)` Registers the namespace URI.
`boolean`	`removeItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue> item)` Removes key/value pair from the colleciton.
`void`	`removeItemByKey(int key)` Removes element with specified key.
`boolean`	`removeItemByKey(String key)` Removes key from the dictionary.
`void`	`set_Item(String key, XmpValue value)` Sets value by key.
`void`	`setByDefaultMetadataProperties(int key, XmpValue value)` Sets value of XMP metadata by key.
`int`	`size()` Gets count if items in the collection.
`boolean`	`tryGetValue(String key, Object[] value)` Tries to find key in the dictionary and retreives value if found.

Methods inherited from class com.aspose.pdf.facades.SaveableFacade
save, save

Methods inherited from class com.aspose.pdf.facades.Facade
bindPdf, bindPdf, bindPdf, bindPdf, bindPdf, close, dispose, getDocument

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface com.aspose.pdf.facades.IFacade
bindPdf, bindPdf, bindPdf, close

Methods inherited from interface com.aspose.ms.System.IDisposable
dispose

- Constructor Detail
  - PdfXmpMetadata
```
public PdfXmpMetadata()
```
    Constructor for PdfXmpMetadata.
```
 PdfXmlMetadata xmp = new PdfXmpMetadata();
 xmp.bindPdf("input.pdf");
 
```
  - PdfXmpMetadata
```
public PdfXmpMetadata(IDocument document)
```
    Initializes new PdfXmpMetadata object on base of the document.
    
    Parameters:
    
    document - Pdf document.
- Method Detail
  - registerNamespaceURI
```
public void registerNamespaceURI(String prefix,
                                 String namespaceURI)
```
    Registers the namespace URI.
```
 PdfXmpMetadata xmp = new PdfXmpMetadata("input.pdf");
 xmp.registerNamespaceURI("xmp", "http://ns.adobe.com/xap/1.0/");
 
```
    Parameters:
    
    prefix - The prefix.
    
    namespaceURI - The namespace URI.
  - getNamespaceURIByPrefix
```
public String getNamespaceURIByPrefix(String prefix)
```
    Gets namespace URI by prefix.
```
 PdfXmpMetadata xmp = new PdfXmpMetadata("input.pdf");
 System.out.println(xmp.getNamespaceURIByPrefix("xmp"));
 
```
    Parameters:
    
    prefix - The prefix.
    
    Returns:
    
    Namespace URI.
  - getPrefixByNamespaceURI
```
public String getPrefixByNamespaceURI(String namespaceURI)
```
    Gets the prefix by namespace URI.
```
 PdfXmpMetadata xmp = new PdfXmpMetadata("input.pdf");
 System.out.println(xmp.getPrefixByNamespaceURI("http://ns.adobe.com/xap/1.0/"));
 
```
    Parameters:
    
    namespaceURI - Namespace URI.
    
    Returns:
    
    The prefix value.
  - addItem
```
public void addItem(int key,
                    XmpValue value)
```
    Adds value to XMP metadata.
```
 PdfXmpMetadata xmp = new PdfXmpMetadata();
 xmp.bindPdf("input.pdf");
 xmp.add(DefaultMetadataProperties.Nickname, "name1");
 xmp.save(TestSettings.getOutputFile("XMP_AddedValue.pdf"));
 
```
    Parameters:
    
    key - The key name.
    
    value - Value which will be added.
  - add
```
public void add(XmpPdfAExtensionObject xmpPdfAExtensionObject,
                String namespacePrefix,
                String namespaceUri,
                String schemaDescription)
```
    Adds extension field into metadata.
    
    Parameters:
    
    xmpPdfAExtensionObject - The pdf extension object to add.
    
    namespacePrefix - The prefix of schema.
    
    namespaceUri - The namespace uri of schema.
    
    schemaDescription - The optional description of schema.
  - clear
```
public void clear()
```
    Removes all elements from the object.
```
 PdfXmpMetadata xmp = new PdfXmpMetadata();
 xmp.bindPdf("input.pdf");
 xmp.clear();
 
```
    Specified by:
    
    clear in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
  - removeItemByKey
```
public void removeItemByKey(int key)
```
    Removes element with specified key.
```
 PdfXmpMetadata xmp = new PdfXmpMetadata();
 xmp.bindPdf("input.pdf");
 xmp.remove(DefaultMetadataProperties.Nickname);
 
```
    Parameters:
    
    key - Key of the element which will be deleted.
    
    See Also:
    
    DefaultMetadataProperties
  - addItem
```
public void addItem(String key,
                    XmpValue value)
```
    Adds new element to the dictionary object.
```
 PdfXmpMetadata xmp = new PdfXmpMetadata();
 xmp.bindPdf("input.pdf");
 xmp.add("xmp:Nickname", "Nickname1");
 
```
    Specified by:
    
    addItem in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>
    
    Parameters:
    
    key - Key of new element.
    
    value - Value of the element.
  - addItem
```
public void addItem(String key,
                    Object value)
```
    Adds new element to the dictionary object.
    
    Parameters:
    
    key - Key of new element.
    
    value - Value of the element.
  - contains
```
public boolean contains(String key)
```
    Checks if dictionary contains the specified key.
```
 PdfXmpMetadata xmp = new PdfXmpMetadata();
 xmp.bindPdf("input.pdf");
 xmp.add("xmp:Nickname", "Nickname1");
 if (!xmp.contains("xmp:Nickname"))
   System.out.println("Key does not exists");
 
```
    Parameters:
    
    key - Key which will be checked.
    
    Returns:
    
    True - if the dictionary contains the specified key; otherwise, false.
  - contains
```
public boolean contains(int property)
```
    Checks if dictionary contains the specified property.
    
    Parameters:
    
    property - Property which will be checked.
    
    Returns:
    
    True - if the dictionary contains the specified property; otherwise, false.
  - iterator
```
public com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>> iterator()
```
    Gets enumerator object of the dictionary.
    
    Specified by:
    
    iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
    
    Specified by:
    
    iterator in interface com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
    
    Specified by:
    
    iterator in interface Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
    
    Returns:
    
    The enumerator object.
  - getKeys
```
public com.aspose.ms.System.Collections.Generic.IGenericCollection<String> getKeys()
```
    Gets keys from the dictionary.
    
    Specified by:
    
    getKeys in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>
    
    Returns:
    
    ICollection element
  - removeItemByKey
```
public boolean removeItemByKey(String key)
```
    Removes key from the dictionary.
```
 PdfXmpMetadata xmp = new PdfXmpMetadata();
 xmp.bindPdf("input.pdf");
 xmp.remove("xmp:Nickname");
 
```
    Specified by:
    
    removeItemByKey in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>
    
    Parameters:
    
    key - Key which will be removed.
  - getExtensionFields
```
public Hashtable<String,XmpPdfAExtensionSchema> getExtensionFields()
```
    Gets the dictionary of extension fields.
    
    Returns:
    
    Hashtable<String, XmpPdfAExtensionSchema> object
  - getValues
```
public com.aspose.ms.System.Collections.Generic.IGenericCollection<XmpValue> getValues()
```
    Gets the collection of values in dictionary.
    
    Specified by:
    
    getValues in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>
    
    Returns:
    
    ICollection object
  - get_Item
```
public XmpValue get_Item(String key)
```
    Gets value by key.
```
 PdfXmpMetadata pxm = new PdfXmpMetadata();
 pxm.bindPdf("PdfFile.pdf");
 System.out.println(pxm.get_Item("xmp:Nickname"));
 
```
    Specified by:
    
    get_Item in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>
    
    Parameters:
    
    key - The key name to get.
    
    Returns:
    
    Object by key
  - set_Item
```
public void set_Item(String key,
                     XmpValue value)
```
    Sets value by key.
```
 PdfXmpMetadata pxm = new PdfXmpMetadata();
 pxm.bindPdf("PdfFile.pdf");
 System.out.println(pxm.get_Item("xmp:Nickname"));
 
```
    Specified by:
    
    set_Item in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>
    
    Parameters:
    
    key - The key name to set.
    
    value - The value to set.
  - isFixedSize
```
public boolean isFixedSize()
```
    Returns true is collection has fixed size.
    
    Returns:
    
    boolean value
  - isReadOnly
```
public boolean isReadOnly()
```
    Returns true if collection is read-only.
    
    Specified by:
    
    isReadOnly in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
    
    Returns:
    
    boolean value
  - copyToTArray
```
public void copyToTArray(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>[] array,
                         int index)
```
    Copy metadata into array.
    
    Specified by:
    
    copyToTArray in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
    
    Parameters:
    
    array - The destination array.
    
    index - The starting index.
  - size
```
public int size()
```
    Gets count if items in the collection.
    Specified by:
    
    size in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
    
    Returns:
    int value
    
    PdfXmpMetadata pxm = new PdfXmpMetadata(); pxm.bindPdf("PdfFile.pdf"); System.out.println("Count = " + pxm.size());
  - isSynchronized
```
public boolean isSynchronized()
```
    Returns true if collection is synchronized.
    
    Returns:
    
    boolean value
  - getSyncRoot
```
public Object getSyncRoot()
```
    Gets synchroniztion object of the collection.
    
    Returns:
    
    Object element
  - iteratorIt
```
public com.aspose.ms.System.Collections.IEnumerator iteratorIt()
```
    Gets enumerator object of the collection.
    
    Returns:
    
    IEnumerator object
  - iterator_Rename_Namesake
```
public com.aspose.ms.System.Collections.IEnumerator iterator_Rename_Namesake()
```
  - getByDefaultMetadataProperties
```
public XmpValue getByDefaultMetadataProperties(int key)
```
    Gets value of XMP metadata by key.
```
 PdfXmpMetadata pxm = new PdfXmpMetadata();
 pxm.bindPdf("PdfFile.pdf");
 System.out.println(pxm.get_Item(DefaultMetadataProperties.CreatorTool));
 
```
    Parameters:
    
    key - Key of the value.
    
    Returns:
    
    Value from XMP metadata.
    
    See Also:
    
    DefaultMetadataProperties
  - setByDefaultMetadataProperties
```
public void setByDefaultMetadataProperties(int key,
                                           XmpValue value)
```
    Sets value of XMP metadata by key.
```
 PdfXmpMetadata pxm = new PdfXmpMetadata();
 pxm.bindPdf("PdfFile.pdf");
 System.out.println(pxm.get_Item(DefaultMetadataProperties.CreatorTool));
 
```
    Parameters:
    
    key - Key of the DefaultMetadataProperties value.
    
    value - Object.
    
    See Also:
    
    DefaultMetadataProperties
  - getXmpMetadata
```
public byte[] getXmpMetadata()
```
    Get the XmpMetadata of the input pdf in a xml format.
```
 PdfXmpMetadata pxm = new PdfXmpMetadata();
 pxm.bindPdf("PdfFile.pdf");
 byte[] data = pxm.getXmpMetadata();
 
```
    Returns:
    
    The bytes of the XmpMetadata.
  - getXmpMetadata
```
public byte[] getXmpMetadata(String name)
```
    Get a part of the XmpMetadata of the input pdf according to a meta name.
```
 PdfXmpMetadata pxm = new PdfXmpMetadata();
 pxm.bindPdf("PdfFile.pdf");
 byte[] data = pxm.getXmpMetadata("dc:creator");
 
```
    Parameters:
    
    name - Metadata name.
    
    Returns:
    
    Bytes of metadata.
  - containsKey
```
public boolean containsKey(String key)
```
    Determines does this dictionary contasins specified key.
    
    Specified by:
    
    containsKey in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>
    
    Parameters:
    
    key - Key to search in the dictionary.
    
    Returns:
    
    true if key is found.
  - tryGetValue
```
public boolean tryGetValue(String key,
                           Object[] value)
```
    Tries to find key in the dictionary and retreives value if found.
    
    Specified by:
    
    tryGetValue in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XmpValue>
    
    Parameters:
    
    key - Key to search in the dictionary.
    
    value - Retreived value.
    
    Returns:
    
    true if key was found.
  - addItem
```
public void addItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue> item)
```
    Adds pair with key and value into the dictionary.
    
    Specified by:
    
    addItem in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
    
    Parameters:
    
    item - Item to be added.
  - containsItem
```
public boolean containsItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue> item)
```
    Checks does specified key-value pair is contained in the dictionary.
    
    Specified by:
    
    containsItem in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
    
    Parameters:
    
    item - Key-value pair.
    
    Returns:
    
    true if this pauir was found.
  - removeItem
```
public boolean removeItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue> item)
```
    Removes key/value pair from the colleciton.
    
    Specified by:
    
    removeItem in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XmpValue>>
    
    Parameters:
    
    item - Key/value pair to be removed.
    
    Returns:
    
    true if pair was found and removed.

Packages

com.aspose.pdf.facades

Interfaces

Classes

Class PdfXmpMetadata

Constructor Summary

Method Summary

Methods inherited from class com.aspose.pdf.facades.SaveableFacade

Methods inherited from class com.aspose.pdf.facades.Facade

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.aspose.pdf.facades.IFacade

Methods inherited from interface com.aspose.ms.System.IDisposable

Constructor Detail

PdfXmpMetadata

PdfXmpMetadata

Method Detail

registerNamespaceURI

getNamespaceURIByPrefix

getPrefixByNamespaceURI

addItem

add

clear

removeItemByKey

addItem

addItem

contains

contains

iterator

getKeys

removeItemByKey

getExtensionFields

getValues

get_Item

set_Item

isFixedSize

isReadOnly

copyToTArray

size

isSynchronized

getSyncRoot

iteratorIt

iterator_Rename_Namesake

getByDefaultMetadataProperties

setByDefaultMetadataProperties

getXmpMetadata

getXmpMetadata

containsKey

tryGetValue

addItem

containsItem

removeItem