XNode (Ceryle API Documentation)

XNode is an abstract class for an object acting as a container for XML content. XNode provides an envelope element and an extensible metadata container (in an <xnode:Header> element) for attributes such as a node ID, creation and modification timestamps, etc., with the document content stored in an <xnode:Body> element.

The current XNode version is indicated by the XML Namespace value found in XMLNS_xnode12.

Notes

Note 1:: XNode 1.3 is completely backward-compatible with XNode 1.2, adding the ability to contain a new XNodeLink class (expressed in XML syntax by the <xnode:Link> Element) within properties. XNodeIDs are the targets of XNodeLinks.
Note 2:: XNode 1.2 adds revision control features but is essentially backwards compatible with 1.1. Over the history of the XNode API attributes have included the XML Namespace prefix. In XNode 1.2 all attributes are unprefixed so as to simplify the syntax (and given prefixing attributes within the same element namespace is a silly thing).
Note 3:: XNode 1.1 is nominally backward-compatible with XNode 1.0, but but no longer supports deprecated methods, and uses a different XML Namespace identifier (see XMLNS_xnode). XNode 1.1 now includes event-handling methods to track changes to the XNodeStore, and also allows for embedded XML content as XNode metadata.
Note 4:: The protected constructors and methods in this class are generally called by XNodeFactory or XNodeStore.
Note 5:: Date and time strings should follow the combined date and format defined in §5.4 of International Standard ISO 8601, "YYYY-MM-DD'T'hh:mm:ss", e.g., "2003-08-19T13:47:22". No time zone indicator is included as stored values should always be in Coordinated Universal Time (UTC). For more information, see: ISO 8601.

Field Summary
`static String`	`ATTR_created` The local name of the `created` attribute.
`static String`	`ATTR_id` The local name of the `id` attribute.
`static String`	`ATTR_index` The local name of the `index` attribute.
`static String`	`ATTR_modified` The local name of the `modified` attribute.
`static String`	`ATTR_name` The local name of the `name` attribute.
`static String`	`ATTR_size` The local name of the `size` attribute.
`static String`	`ATTR_value` The local name of the `value` attribute.
`static String`	`ATTR_version` The local name of the `version` attribute.
`static String`	`ATTR_weight` The local name of the `weight` attribute.
`static String`	`ELT_body` The local name of the `<xnode:Body>` element.
`static String`	`ELT_collection` The local name of the `<xnode:Collection>` element.
`static String`	`ELT_envelope` The local name of the `<xnode:Envelope>` element.
`static String`	`ELT_header` The local name of the `<xnode:Header>` element.
`static String`	`ELT_link` The local name of the `<xnode:Link>` element.
`static String`	`ELT_property` The local name of the `<xnode:Property>` element.
`static String`	`ELT_repository` The local name of the `<xnode:Repository>` element.
`static String`	`ELT_revision` The local name of the `<xnode:Revision>` element.
`static String`	`ELT_text` The local name of the `<xnode:Text>` element.
`static String`	`VERSION_10` A String containing the XNode 1.0 version string.
`static String`	`VERSION_11` A String containing the XNode 1.1 version string.
`static String`	`VERSION_12` A String containing the XNode 1.2 version string.
`static String`	`VERSION_13` A String containing the XNode 1.3 version string.
`static String`	`XMLNS_base` A String containing a URI identifying the base XNode XML Namespace.
`static String`	`XMLNS_pfx` The default XML Namespace prefix for XNode 1.x.
`static String`	`XMLNS_xnode` The XML namespace identifier set to the most recent version of the XNode API.
`static String`	`XMLNS_xnode10` A String containing a URI identifying the deprecated XNode 1.0 XML Namespace.
`static String`	`XMLNS_xnode11` A String containing a URI identifying the deprecated XNode 1.1 XML Namespace.
`static String`	`XMLNS_xnode12` A String containing a URI identifying the XNode 1.2 XML Namespace.
`static String`	`XMLNS_xnode13` A String containing a URI identifying the XNode 1.3 XML Namespace.

Constructor Summary
`protected`	`XNode(String nid)` Constructor with a required ID `nid`.
`protected`	`XNode(String nid, Node content)` Constructor with a required ID `nid` and a DOM Node `content`.

Method Summary
`abstract Node`	`getContent()` Return a DOM Node containing this XNode's embedded content (exclusive of the XNode envelope), null if not set.
`abstract String`	`getCreated()` Return the creation date of this XNode as a String.
`String`	`getID()` Return the ID of this XNode as a String.
`abstract String`	`getModified()` Return the modification date of this XNode as a String.
`abstract Set`	`getProperties()` Return a Set containing all named properties of this XNode, an empty Set (not null) if none have been set.
`abstract Object`	`getProperty(String name)` Return the named property `name` as an Object, null if it has not been set.
`abstract List`	`getRepository()` Returns the List backing this XNode's repository (i.e., the List of individual `XNodeRevision` objects).
`abstract void`	`modifyContent(Node content)` Modifies this XNode by setting its content to the DOM Node `content`.
`protected abstract void`	`setContent(Node content)` Set the content of this XNode to the DOM Node `content`.
`abstract void`	`setCreated(String timestamp)` Set the creation date of this XNode to the String `timestamp`.
`protected void`	`setID(String nid)` Set the ID of this XNode to the String `nid`.
`abstract void`	`setModified(String timestamp)` Set the modification date of this XNode to the String `timestamp`.
`abstract void`	`setProperty(String name, Object value)` Set the named property `name` to the Object `value`.
`abstract String`	`toString()` Return a String representation of this XNode, including the XNode envelope.
`abstract String`	`toString(boolean includeEnvelope)` Return a String representation of this XNode, including the envelope if `includeEnvelope` is true.

org.purl.xnode Class XNode

Notes

Note 1:

Note 2:

Note 3:

Note 4:

Note 5:

XMLNS_base

VERSION_13

XMLNS_xnode13

VERSION_12

XMLNS_xnode12

VERSION_11

XMLNS_xnode11

VERSION_10

XMLNS_xnode10

XMLNS_xnode

XMLNS_pfx

ELT_envelope

ELT_header

ELT_body

ELT_text

ELT_property

ELT_link

ELT_repository

ELT_revision

ELT_collection

ATTR_id

ATTR_created

ATTR_modified

ATTR_name

ATTR_value

ATTR_version

ATTR_size

ATTR_index

ATTR_weight

XNode

XNode

setID

getID

setCreated

getCreated

setModified

getModified

setProperty

getProperty

getProperties

setContent

modifyContent

getContent

getRepository

toString

Note:

toString

org.purl.xnode
Class XNode