buri.ddmsence.ddms.extensible

Class ExtensibleElement

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.extensible.ExtensibleElement

All Implemented Interfaces:

IDDMSComponent

public final class ExtensibleElement
extends AbstractBaseComponent

An immutable implementation of an element which might fulfill the xs:any space in the Extensible Layer.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Extensible elements must live in any other namespace besides the DDMS XML namespace.

No validation or processing of any kind is performed by DDMSence on extensible attributes, other than the base validation used when loading attributes from an XML file. This class merely exposes a getXOMElementCopy() method which returns a XOM Element that can be manipulated in business-specific ways.

XOM elements can be created as follows:

Element element = new Element("ddmsence:extension", "https://ddmsence.urizone.net/");
element.appendChild("This will be the child text.");

Because it is impossible to cover all of the HTML/JSON/Text output cases for ExtensibleElements, DDMSence will simply print out the existence of extensible elements at the Resource level:

Extensible Layer: true
<meta name="extensible.layer" content="true" />
{"extensible.layer":true}


Details about the XOM Element class can be found at: http://www.xom.nu/apidocs/index.html?nu/xom/Element.html

History
In DDMS 2.0, only one element is allowed on the resource. In DDMS 3.0 - 4.1, zero to many may appear. The ExtensibleElement extension point was removed in DDMS 5.0.

Nested Elements
Name Cardinality Availability any:<extensibleElements> 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 any:<extensibleElements> 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes
Name Cardinality Availability None.

Validation Rules
Rule Type Applicability An extensible element must not be in the DDMS namespace. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Since:

1.1.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtensibleElement.Builder Builder for this DDMS component.

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
ExtensibleElement(nu.xom.Element element) Constructor for creating a component from a XOM Element

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getHTMLTextOutput(OutputFormat format, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
com.google.gson.JsonObject	getJSONObject() Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.
int	hashCode() Returns a hashcode for the component.
protected void	validate() Base case for validation.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getNestedComponents, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML, validateWarnings

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExtensibleElement

public ExtensibleElement(nu.xom.Element element)
                  throws InvalidDDMSException

Constructor for creating a component from a XOM Element

Parameters:

element - the XOM element representing this

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Description copied from class: AbstractBaseComponent

Base case for validation. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException

See Also:

AbstractBaseComponent.validate()

getJSONObject

public com.google.gson.JsonObject getJSONObject()

Description copied from class: AbstractBaseComponent

Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object. Although this method is marked a public, it is only intended to be used internally, and is not part of the IDDMSComponent interface. Use the toJSON() method as the public way to get JSON output.

Specified by:

getJSONObject in class AbstractBaseComponent

See Also:

AbstractBaseComponent.getJSONObject()

getHTMLTextOutput

public String getHTMLTextOutput(OutputFormat format,
                                String prefix,
                                String suffix)

Description copied from class: AbstractBaseComponent

Renders this component as HTML or Text, with an optional prefix to nest it.

I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toHTML() and toText() as the formal, public methods to generate output.

Specified by:

getHTMLTextOutput in class AbstractBaseComponent

Parameters:

format - the desired format of this output

prefix - an optional prefix to put on each name.

suffix - an optional suffix to append to each name, such as an index.

Returns:

the representation of this component in the specified format

See Also:

AbstractBaseComponent.getHTMLTextOutput(OutputFormat, String, String)

equals

public boolean equals(Object obj)

Description copied from class: AbstractBaseComponent

Test for logical equality.

The base case tests against the name value and namespaceURI, as well as any child components classified as "nested components" and any security attributes. Extending classes may require additional rules for equality. This case automatically includes any nested components or security attributes.

Overrides:

equals in class AbstractBaseComponent

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Description copied from class: AbstractBaseComponent

Returns a hashcode for the component.

This automatically includes any nested components or security attributes.

Overrides:

hashCode in class AbstractBaseComponent

See Also:

Object.hashCode()