Xmp Chilkat2 Java Reference Documentation
Xmp
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.Xmp
Load a
Retrieve embedded XMP documents as
Add or update namespace-qualified string and integer properties such as
Work with XMP arrays such as
Use built-in namespace mappings or add custom namespace-to-URI mappings
for application-specific XMP properties.
Remove properties, arrays, structures, or embedded XMP documents, then
persist changes to a file or return the updated image as a byte buffer.
Read, modify, add, remove, and save XMP metadata in JPG and TIFF files.
Chilkat.Xmp is a legacy class for working with embedded XMP
metadata in JPG and TIFF image files. It can load
image files or image data from memory, locate embedded XMP documents, return
XMP metadata as Chilkat.Xml, create new XMP documents, add or
update simple string and integer properties, manage arrays and structured
properties, add namespace mappings, remove selected XMP properties or entire
embedded XMP documents, and save the updated image back to a file or byte
buffer.
Chilkat.Xmp is maintained for existing JPG/TIFF XMP workflows,
but it is not planned to be extended to support additional file types.
Load JPG or TIFF metadata
JPG or TIFF file from disk or memory and
inspect how many embedded XMP documents were found.
Access XMP as XML
Chilkat.Xml objects for
inspection, editing, or direct XML-level processing.
Add simple properties
dc:subject, photoshop:Credit, or
tiff:XResolution.
Arrays and structures
bag, seq, and
alt, and manage structured property values.
Namespaces
Remove and save
LoadAppFile or
LoadFromBuffer, retrieve an embedded XMP document with
GetEmbedded or create one with NewXmp, modify it
using the add/remove property methods, then call SaveAppFile or
SaveToBuffer to persist the updated image metadata.
SaveAppFile is called. For memory workflows, use
SaveToBuffer to obtain the updated JPG or TIFF bytes.
Object Creation
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Xmp;
try (Xmp xmp = new Xmp()) {
// ... use xmp ...
} catch (ChilkatException e) {
System.out.println(e.getMessage()); // "Xmp.someMethod failed: <reason>"
System.out.println(e.getLastErrorText()); // the full log of the failed call
}Creates the underlying native Chilkat object. The native library (chilkat2java) is loaded the first time any Chilkat2 object is created; see the README in the download for where it is looked for (-Dchilkat2.library.path, a classpath resource, or java.library.path).
Releases the native object (Xmp is AutoCloseable, so try-with-resources calls it). Calling it again does nothing; any other method or property accessor called afterwards throws IllegalStateException. An object that is never closed is freed by a background cleaner once it becomes unreachable, but the garbage collector does not see native memory, so closing is the normal path. Objects returned by methods are owned by the caller too.
Returns true once close() has been called.
Errors
A method that fails throws ChilkatException, an unchecked exception carrying getClassName(), getMethodName(), getReason() (one line, also in the message) and getLastErrorText() (the full log, captured at the moment of the failure). The object remains usable. Methods that look something up and find nothing return null instead of throwing (each such method says so), and methods that answer a question (hasMember, isUnlocked, ...) return a plain boolean. Property accessors do not throw for Chilkat reasons.
A null string or object argument throws NullPointerException naming the parameter (except where a method documents that null is accepted), and a string containing U+0000 throws IllegalArgumentException.
Use an object from one thread at a time; it may be handed from one thread to another. The one cross-thread operation is setting setAbortCurrent(true) on an object that is busy in another thread (on the classes that have AbortCurrent). Unlocking: call new Global().unlockBundle("...") once at startup.
Properties
DebugLogFilePath
String getDebugLogFilePath()
void setDebugLogFilePath(String value)
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
String getLastErrorHtml()
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
String getLastErrorText()
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
String getLastErrorXml()
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
boolean getLastMethodSuccess()
void setLastMethodSuccess(boolean value)
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
NumEmbedded
int getNumEmbedded()
The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.
topStructInnerDescrip
boolean getStructInnerDescrip()
void setStructInnerDescrip(boolean value)
Determines whether structures are stored with rdf:parseType=Resource, or within an rdf:Description sub-node.
UncommonOptions
String getUncommonOptions()
void setUncommonOptions(String value)
A property to be used for future uncommon needs. The default value is the empty string.
topVerboseLogging
boolean getVerboseLogging()
void setVerboseLogging(boolean value)
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
String getVersion()
Methods
AddArray
Adds or replaces an XMP property array. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The 2nd argument specifies the array type, which can be bag, seq, or alt. The property name should be prefixed with the namespace, such as dc:subject.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AddNsMapping
Adds a namespace to URI mapping. When a property is added via AddSimpleString or any of the other methods, the property name is namespace qualified. When adding the first property in a namespace, the rdf:Description is automatically added and the URI is obtained from the namespace-to-URI mappings. The standard (and commonly used) namespace mappings are defined by default. This is only used if the namespace is custom or not already handled.
topAddSimpleInt
Adds or updates an XMP integer property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as tiff:XResolution.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AddSimpleStr
Adds or updates a simple XMP string property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as photoshop:Credit.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AddStructProp
Adds or updates an XMP structured property value. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The structure name should be prefixed with the namespace, such as Iptc4xmpCore:CreatorContactInfo. The property name within the structure should also be prefixed with the namespace, such as Iptc4xmpCore:CiAdrCity.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
Append
Appends a new XMP metadata file to the XMP object. Any XMPs appended via this method will be present in the file when SaveAppFile is called. Files containing XMP metadata typically only include a single XMP document, so this method is usually only called when adding XMP metadata to a file for the first time.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
GetArray
Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as dc:subject.
Returns null if not found (this is not an error and does not throw). The returned object is new and owned by the caller: close it when done (try (...)), or let it be garbage-collected.
GetEmbedded
Returns the Nth embedded XMP document as a Chilkat XML object.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable. The returned object is new and owned by the caller: close it when done (try (...)), or let it be garbage-collected.
GetProperty
To be documented soon...
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable. The returned object is new and owned by the caller: close it when done (try (...)), or let it be garbage-collected.
GetSimpleInt
Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as tiff:ResolutionUnit.
GetSimpleStr
Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as photoshop:Source.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
GetStructPropNames
Returns the property names used by an exsting structure within an XMP document. The contents of the structure can be retrieved by calling GetStructValue for each property name returned by GetStructPropNames.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable. The returned object is new and owned by the caller: close it when done (try (...)), or let it be garbage-collected.
GetStructValue
Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
LoadAppFile
Loads a TIFF or JPG file into the XMP object.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
NewXmp
Creates and returns a new/empty XMP metadata document as a Chilkat XML object.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable. The returned object is new and owned by the caller: close it when done (try (...)), or let it be garbage-collected.
RemoveAllEmbedded
Removes all XMP metadata documents from an XMP object. After calling this method, call SaveAppFile to rewrite the JPG or TIFF file with the XMP metadata removed.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
RemoveArray
Removes an XMP array property from the XMP document.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
RemoveEmbedded
Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
RemoveNsMapping
Removes a namespace-to-URI mapping.
topRemoveSimple
Removes a simple XMP property from the XMP document.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
RemoveStruct
Removes an XMP structure property from the XMP document.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
RemoveStructProp
Removes a single member from an XMP structured property.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
SaveAppFile
Persists all changes made to the XMP document(s) by saving the XMP object to a file. Changes made by adding, updating, or removing properties are not persisted to the filesystem until this is called.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.