buri.ddmsence.ddms.summary

Class Keyword

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.summary.Keyword

All Implemented Interfaces:

IDDMSComponent

public final class Keyword
extends AbstractBaseComponent

An immutable implementation of ddms:keyword.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
None.

Nested Elements
Name Cardinality Availability None.

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

Validation Rules

Rule Type Applicability The qualified name of this element must be correct. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:value must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 Security attributes must not be used before the DDMS version in which they were introduced. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 Extensible attributes must not be used before the DDMS version in which they were introduced. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
Keyword(nu.xom.Element element) Constructor for creating a component from a XOM Element
Keyword(String value, SecurityAttributes securityAttributes) Constructor for creating a component from raw data
Keyword(String value, SecurityAttributes securityAttributes, ExtensibleAttributes extensibleAttributes) Constructor for creating a component from raw data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
ExtensibleAttributes	getExtensibleAttributes() Accessor for the extensible attributes.
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.
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
String	getValue() Accessor for the value attribute.
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, 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

Keyword

public Keyword(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

Keyword

public Keyword(String value,
               SecurityAttributes securityAttributes)
        throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

value - the value attribute

securityAttributes - any security attributes

Throws:

InvalidDDMSException - if any required information is missing or malformed

Keyword

public Keyword(String value,
               SecurityAttributes securityAttributes,
               ExtensibleAttributes extensibleAttributes)
        throws InvalidDDMSException

Constructor for creating a component from raw data.

This constructor will throw an InvalidDDMSException if the extensible attributes uses the reserved attribute "ddms:value".

Parameters:

value - the value attribute

securityAttributes - any security attributes

extensibleAttributes - extensible attributes

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()

getName

public static String getName(DDMSVersion version)

Accessor for the element name of this component, based on the version of DDMS used

Parameters:

version - the DDMSVersion

Returns:

an element name

getValue

public String getValue()

Accessor for the value attribute.

getSecurityAttributes

public SecurityAttributes getSecurityAttributes()

Accessor for the Security Attributes. Will always be non-null, even if it has no values set.

Specified by:

getSecurityAttributes in interface IDDMSComponent

Overrides:

getSecurityAttributes in class AbstractBaseComponent

getExtensibleAttributes

public ExtensibleAttributes getExtensibleAttributes()

Accessor for the extensible attributes. Will always be non-null, even if not set.