buri.ddmsence.ddms.extensible

Class ExtensibleAttributes

Object

buri.ddmsence.AbstractAttributeGroup

buri.ddmsence.ddms.extensible.ExtensibleAttributes

public final class ExtensibleAttributes
extends AbstractAttributeGroup

Attribute group representing the xs:anyAttribute tag which appears on various DDMS components.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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, and a check to confirm that extensible attributes do not collide with existing attributes. This class merely exposes a getAttributes() method which returns a read-only List of XOM Attributes that can be manipulated in business-specific ways.

For example, this ddms:Keyword would have an ExtensibleAttributes instance containing 2 attributes (assuming that the "opensearch" namespace was defined earlier in the file):

<ddms:Keyword ddms:value="xml" opensearch:relevance="95" opensearch:confidence="82" />

XOM attributes can be created as follows:

Attribute attribute = new Attribute("opensearch:relevance", "http://opensearch.namespace/", "95");
Attribute attribute = new Attribute("opensearch:confidence", "http://opensearch.namespace/", "82");

The DDMS documentation does not provide sample HTML/Text output for extensible attributes, so the following approach is used. In general, the output of extensible attributes will be prefixed with the name of the element being marked. For example:

keyword opensearch:relevance: 95
keyword opensearch:confidence: 82

<meta name="subjectCoverage.Subject.keyword.opensearch.relevance" content="95" />
<meta name="subjectCoverage.Subject.keyword.opensearch.confidence" content="82" />


When output as JSON, properties will retain their namespace prefix. Because all values are stored as Strings, no casting is performed to Boolean or Number types.

{"extensibleAttributes":{"opensearch.relevance":"95","opensearch.confidence":"82"}}

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

History

In DDMS 2.0, this attribute group can only decorate Organization, Person, Service, or the Resource. In DDMS 3.0 and 3.1, this attribute group can decorate Organization, Person, Service, Unknown, Keyword, Category, or the Resource itself. In DDMS 4.0.1 and 4.1, this attribute group was removed from Person. In DDMS 5.0, this attribute group was also removed from Organization and Resource. It is anticipated that all remaining extension points will be deprecated in the next release.

Nested Elements
Name Cardinality Availability None.

Attributes
Name Cardinality Availability any:<extensibleAttributes> 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules
Rule Type Applicability Extensible attributes are not validated by DDMSence.

Since:

1.1.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtensibleAttributes.AttributeBuilder Builder for a XOM attribute.
static class	ExtensibleAttributes.Builder Builder for these attributes.

Field Summary

Fields inherited from class buri.ddmsence.AbstractAttributeGroup

INCOMPATIBLE_VERSION_MESSAGE

Constructor Summary

Constructors

Constructor and Description
ExtensibleAttributes(nu.xom.Element element) Base constructor
ExtensibleAttributes(List<nu.xom.Attribute> attributes) Constructor which builds from raw data.

Method Summary

Modifier and Type	Method and Description
void	addTo(nu.xom.Element element) Convenience method to add these attributes onto an existing XOM Element
boolean	equals(Object obj)
List<nu.xom.Attribute>	getAttributes() Accessor for the attributes.
String	getHTMLTextOutput(OutputFormat format, String prefix) Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.
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.
String	getName() Returns a name that describes this attribute group.
static ExtensibleAttributes	getNonNullInstance(ExtensibleAttributes extensibleAttributes) Returns a non-null instance of extensible attributes.
int	hashCode()
boolean	isEmpty() Checks if any attributes have been set.
protected void	validate(DDMSVersion version) Currently, no further validation is performed.

Methods inherited from class buri.ddmsence.AbstractAttributeGroup

addJson, addJson, getNamespace, getValidationWarnings, getWarnings, setNamespace

Methods inherited from class Object

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

Constructor Detail

ExtensibleAttributes

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

Base constructor

Will only load attributes from a different namespace than DDMS (##other) and will also skip any Resource attributes that are reserved.

Parameters:

element - the XOM element which is decorated with these attributes.

Throws:

InvalidDDMSException

ExtensibleAttributes

public ExtensibleAttributes(List<nu.xom.Attribute> attributes)
                     throws InvalidDDMSException

Constructor which builds from raw data. Because the parent is not known at this time, will accept all attributes. The method, addTo() will confirm that the names do not clash with existing or reserved names on the element.

Parameters:

attributes - a list of extensible attributes

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

getNonNullInstance

public static ExtensibleAttributes getNonNullInstance(ExtensibleAttributes extensibleAttributes)
                                               throws InvalidDDMSException

Returns a non-null instance of extensible attributes. If the instance passed in is not null, it will be returned.

Parameters:

extensibleAttributes - the attributes to return by default

Returns:

a non-null attributes instance

Throws:

InvalidDDMSException - if there are problems creating the empty attributes instance

addTo

public void addTo(nu.xom.Element element)
           throws InvalidDDMSException

Convenience method to add these attributes onto an existing XOM Element

Parameters:

element - the element to decorate

Throws:

InvalidDDMSException - if the attribute already exists

isEmpty

public boolean isEmpty()

Description copied from class: AbstractAttributeGroup

Checks if any attributes have been set.

Specified by:

isEmpty in class AbstractAttributeGroup

Returns:

true if no attributes have values, false otherwise

See Also:

AbstractAttributeGroup.isEmpty()

validate

protected void validate(DDMSVersion version)
                 throws InvalidDDMSException

Currently, no further validation is performed.

Overrides:

validate in class AbstractAttributeGroup

Parameters:

version - the DDMS version to validate against. This cannot be stored in the attribute group because some DDMSVersions have the same attribute XML namespace (e.g. XLink, ISM, NTK, GML after DDMS 2.0).

Throws:

InvalidDDMSException - if any required information is missing or malformed

getJSONObject

public com.google.gson.JsonObject getJSONObject()

Description copied from class: AbstractAttributeGroup

Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.

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

Specified by:

getJSONObject in class AbstractAttributeGroup

See Also:

AbstractAttributeGroup.getJSONObject()

getName

public String getName()

Description copied from class: AbstractAttributeGroup

Returns a name that describes this attribute group. The format of the name is the class name with a lower-case first letter. This method is used in JSON output.

Specified by:

getName in class AbstractAttributeGroup

See Also:

AbstractAttributeGroup.getName()

getHTMLTextOutput

public String getHTMLTextOutput(OutputFormat format,
                                String prefix)

Description copied from class: AbstractAttributeGroup

Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.

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 AbstractAttributeGroup

Parameters:

format - the desired format of this output

prefix - the prefix to add

Returns:

the output

See Also:

AbstractAttributeGroup.getHTMLTextOutput(OutputFormat, String)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

getAttributes

public List<nu.xom.Attribute> getAttributes()

Accessor for the attributes. Returns a copy.