CkXmp Java Reference Documentation

CkXmp

Current Version: 9.5.0.75

Chilkat XMP is a software component (SDK, toolkit, library, etc) for accessing, manipulating, and adding XMP metadata to JPEG and TIFF files.

Object Creation

CkXmp obj = new CkXmp();

Properties

DebugLogFilePath
void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
void get_LastErrorHtml(CkString str);
String lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
void get_LastErrorText(CkString str);
String lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
void get_LastErrorXml(CkString str);
String lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumEmbedded
int get_NumEmbedded();

The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.

top
StructInnerDescrip
boolean get_StructInnerDescrip();
void put_StructInnerDescrip(boolean newVal);

Determines whether structures are stored with rdf:parseType="Resource", or within an "rdf:Description" sub-node.

top
VerboseLogging
boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

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.

top
Version
void get_Version(CkString str);
String version();

Version of the component/library, such as "9.5.0.63"

top

Methods

AddArray
boolean AddArray(CkXml xml, String arrType, String propName, CkStringArray values);

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".

top
AddNsMapping
void AddNsMapping(String ns, String uri);

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.

top
AddSimpleInt
boolean AddSimpleInt(CkXml iXml, String propName, int propVal);

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".

top
AddSimpleStr
boolean AddSimpleStr(CkXml iXml, String propName, String propVal);

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".

top
AddStructProp
boolean AddStructProp(CkXml iChilkatXml, String structName, String propName, String propValue);

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".

top
Append
boolean Append(CkXml iXml);

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.

top
GetArray
CkStringArray GetArray(CkXml iXml, String propName);

Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as "dc:subject".

Returns nil on failure

top
GetEmbedded
CkXml GetEmbedded(int index);

Returns the Nth embedded XMP document as a Chilkat XML object.

Returns nil on failure

top
GetProperty
CkXml GetProperty(CkXml iXml, String propName);

To be documented soon...

Returns nil on failure

top
GetSimpleInt
int GetSimpleInt(CkXml iXml, String propName);

Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as "tiff:ResolutionUnit".

top
GetSimpleStr
boolean GetSimpleStr(CkXml iXml, String propName, CkString outStr);
String getSimpleStr(CkXml iXml, String propName);

Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as "photoshop:Source".

Returns true for success, false for failure.

top
GetStructPropNames
CkStringArray GetStructPropNames(CkXml iXml, String structName);

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.

Returns nil on failure

top
GetStructValue
boolean GetStructValue(CkXml iXml, String structName, String propName, CkString outStr);
String getStructValue(CkXml iXml, String structName, String propName);

Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace.

Returns true for success, false for failure.

top
LoadAppFile
boolean LoadAppFile(String filename);

Loads a TIFF or JPG file into the XMP object.

top
LoadFromBuffer
boolean LoadFromBuffer(CkByteData fileData, String ext);

Loads a JPG or TIFF from an byte buffer containing the image file data.

top
NewXmp
CkXml NewXmp();

Creates and returns a new/empty XMP metadata document as a Chilkat XML object.

Returns nil on failure

top
RemoveAllEmbedded
boolean 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.

Returns true for success, false for failure.

top
RemoveArray
boolean RemoveArray(CkXml iXml, String propName);

Removes an XMP array property from the XMP document.

top
RemoveEmbedded
boolean RemoveEmbedded(int index);

Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.

Returns true for success, false for failure.

top
RemoveNsMapping
void RemoveNsMapping(String ns);

Removes a namespace-to-URI mapping.

top
RemoveSimple
boolean RemoveSimple(CkXml iXml, String propName);

Removes a simple XMP property from the XMP document.

top
RemoveStruct
boolean RemoveStruct(CkXml iXml, String structName);

Removes an XMP structure property from the XMP document.

top
RemoveStructProp
boolean RemoveStructProp(CkXml iXml, String structName, String propName);

Removes a single member from an XMP structured property.

top
SaveAppFile
boolean SaveAppFile(String filename);

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.

top
SaveLastError
boolean SaveLastError(String path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SaveToBuffer
boolean SaveToBuffer(CkByteData outData);

Saves a JPG or TIFF image with updated XMP to a byte buffer.

Returns true for success, false for failure.

top
UnlockComponent
boolean UnlockComponent(String unlockCode);

Unlocks the XMP component at runtime. This must be called once at the beginning of your application. Passing an arbitrary value initiates a fully-functional 30-day trial. A purchased unlock code is required to use the component beyond 30 days.

top