CkAtom Java Reference Documentation

CkAtom

Current Version: 9.5.0.73

Represents an Atom document. The Atom API allows one to download, create and modify Atom documents.

Object Creation

CkAtom obj = new CkAtom();

Properties

AbortCurrent
boolean get_AbortCurrent();
Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

top
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
NumEntries
int get_NumEntries();

Number of entries in the Atom document.

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

AddElement
int AddElement(String tag, String value);

Adds a new element to the Atom document. The tag is a string such as "title", "subtitle", "summary", etc. Returns the index of the element added, or -1 for failure.

top
AddElementDateStr
int AddElementDateStr(String tag, String dateTimeStr);

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. The dateTimeStr should be an RFC822 formatted date/time string such as "Tue, 25 Sep 2012 12:25:32 -0500". Returns the index of the element added, or -1 for failure.

top
AddElementDt
int AddElementDt(String tag, CkDateTime dateTime);

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. Returns the index of the element added, or -1 for failure.

top
AddElementHtml
int AddElementHtml(String tag, String htmlStr);

Adds a new HTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

top
AddElementXHtml
int AddElementXHtml(String tag, String xmlStr);

Adds a new XHTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

top
AddElementXml
int AddElementXml(String tag, String xmlStr);

Adds a new XML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

top
AddEntry
void AddEntry(String xmlStr);

Adds an "entry" Atom XML document to the caller's Atom document.

top
AddLink
void AddLink(String rel, String href, String title, String typ);

Adds a link to the Atom document.

top
AddPerson
void AddPerson(String tag, String name, String uri, String email);

Adds a person to the Atom document. The tag should be a string such as "author", "contributor", etc. If a piece of information is not known, an empty string or NULL value may be passed.

top
DeleteElement
void DeleteElement(String tag, int index);

Removes the Nth occurrence of a given element from the Atom document. Indexing begins at 0. For example, to remove the 2nd category, set tag = "category" and index = 1.

top
DeleteElementAttr
void DeleteElementAttr(String tag, int index, String attrName);

Remove an attribute from an element.The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index ( 0 = first occurrence ).

top
DeletePerson
void DeletePerson(String tag, int index);

Deletes a person from the Atom document. The tag is a string such as "author". The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index. For example, DeletePerson("author",2) deletes the 3rd author.

top
DownloadAtom
boolean DownloadAtom(String url);

Download an Atom feed from the Internet and load it into the Atom object.

Returns true for success, false for failure.

top
DownloadAtomAsync (Android™) (Java)
CkTask DownloadAtomAsync(String url);

Creates an asynchronous task to call the DownloadAtom method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
GetElement
boolean GetElement(String tag, int index, CkString outStr);
String getElement(String tag, int index);

Returns the content of the Nth element having a specified tag.

Returns true for success, false for failure.

top
GetElementAttr
boolean GetElementAttr(String tag, int index, String attrName, CkString outStr);
String getElementAttr(String tag, int index, String attrName);

Returns the value of an element's attribute. The element is selected by the tag name and the index (the Nth element having a specific tag) and the attribute is selected by name.

Returns true for success, false for failure.

top
GetElementCount
int GetElementCount(String tag);

The number of elements having a specific tag.

top
GetElementDateStr
boolean GetElementDateStr(String tag, int index, CkString outStr);
String getElementDateStr(String tag, int index);

Returns an element's value as a date/time in an RFC822 formatted string, such as such as "Tue, 25 Sep 2012 12:25:32 -0500".

Returns true for success, false for failure.

top
GetElementDt
CkDateTime GetElementDt(String tag, int index);

Returns an element's value as a date/time object.

Returns nil on failure

top
GetEntry
CkAtom GetEntry(int index);

Returns the Nth entry as an Atom object. (Indexing begins at 0)

Returns nil on failure

top
GetLinkHref
boolean GetLinkHref(String relName, CkString outStr);
String getLinkHref(String relName);

Returns the href attribute of the link having a specified "rel" attribute (such as "service.feed", "alternate", etc.).

Returns true for success, false for failure.

top
GetPersonInfo
boolean GetPersonInfo(String tag, int index, String tag2, CkString outStr);
String getPersonInfo(String tag, int index, String tag2);

Returns a piece of information about a person. To get the 2nd author's name, call GetPersonInfo("author",1,"name").

Returns true for success, false for failure.

top
GetTopAttr
boolean GetTopAttr(String attrName, CkString outStr);
String getTopAttr(String attrName);

Returns the value of an attribute on the top-level XML node. The tag of a top-level Atom XML node is typically "feed" or "entry", and it might have attributes such as "xmlns" and "xml:lang".

Returns true for success, false for failure.

top
HasElement
boolean HasElement(String tag);

True (1) if the element exists in the Atom document. Otherwise 0.

top
LoadXml
boolean LoadXml(String xmlStr);

Loads the Atom document from an XML string.

Returns true for success, false for failure.

top
NewEntry
void NewEntry();

Initializes the Atom document to be a new "entry".

top
NewFeed
void NewFeed();

Initializes the Atom document to be a new "feed".

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
SetElementAttr
void SetElementAttr(String tag, int index, String attrName, String attrValue);

Adds or replaces an attribute on an element.

top
SetTopAttr
void SetTopAttr(String attrName, String value);

Adds or replaces an attribute on the top-level XML node of the Atom document.

top
ToXmlString
boolean ToXmlString(CkString outStr);
String toXmlString();

Serializes the Atom document to an XML string.

Returns true for success, false for failure.

top
UpdateElement
void UpdateElement(String tag, int index, String value);

Replaces the content of an element.

top
UpdateElementDateStr
void UpdateElementDateStr(String tag, int index, String dateTimeStr);

Replaces the content of a date-formatted element. The index should be an RFC822 formatted date/time string.

top
UpdateElementDt
void UpdateElementDt(String tag, int index, CkDateTime dateTime);

Replaces the content of a date-formatted element.

top
UpdateElementHtml
void UpdateElementHtml(String tag, int index, String htmlStr);

Replaces the content of an HTML element.

top
UpdateElementXHtml
void UpdateElementXHtml(String tag, int index, String xmlStr);

Replaces the content of an XHTML element.

top
UpdateElementXml
void UpdateElementXml(String tag, int index, String xmlStr);

Replaces the content of an XML element.

top
UpdatePerson
void UpdatePerson(String tag, int index, String name, String uri, String email);

Replaces the content of a person. To update the 3rd author, call UpdatePerson("author",2,"new name","new URL","new email"). If a piece of information is not known, pass an empty string or a NULL.

top

Events

Chilkat supports event callbacks in Java (including Android) starting in version 9.5.0.52. To implement an event callback, your application would define and implement a class that derives from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.

For example:

// Install an event callback handler to get progress events.
MyBaseProgress atomProgress = new MyBaseProgress();
http.put_EventCallbackObject(atomProgress);

MyBaseProgress example:

import com.chilkatsoft.CkBaseProgress;
import com.chilkatsoft.CkTask;

public class MyBaseProgress extends CkBaseProgress 
{	
  public boolean AbortCheck()
  {
    System.out.println("AbortCheck");
    // Return true to abort, false to allow the method to continue.
    return false;
  }
  	
  // pctDone is a value from 0 to 100
  // (it is actually value from 0 to the PercentDoneScale property setting)
  public boolean PercentDone(int pctDone)
  {
    System.out.println(pctDone);
    // Return true to abort, false to allow the method to continue.
    // Note: A PercentDone event is the equivalent of an AbortCheck.  
    // When PercentDone events are frequently firing, AbortCheck events are suppressed.
    // AbortCheck events will fire when the time between PercentDone events is longer 
    // than the HeartbeatMs property setting.
    return false;
  }
  
  public void ProgressInfo(String name, String value)
  {
    System.out.println(name + ": " + value);
  }
  
  public void TaskCompleted(CkTask task)
  {
     System.out.println("task completed!");
  }
  
}
AbortCheck
public boolean AbortCheck();

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return true to abort; return false to continue (not abort)

top
PercentDone
public boolean PercentDone(int pctDone);

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

Return true to abort; return false to continue (not abort)

top
ProgressInfo
public void ProgressInfo(String name, String value);

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

top
TaskCompleted
public void TaskCompleted(CkTask task);

Called in the background thread when an asynchronous task completes.

top