buri.ddmsence

Class AbstractSimpleString

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractSimpleString

All Implemented Interfaces:

IDDMSComponent

Direct Known Subclasses:

ApplicationSoftware, Description, Details, NonStateActor, NoticeText, ProcessingInfo, SubOrganization, Subtitle, Title

public abstract class AbstractSimpleString
extends AbstractBaseComponent

Base class for DDMS elements which consist of simple child text, possibly decorated with attributes, such as Description, Title, and Subtitle.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Extensions of this class are generally expected to be immutable, and the underlying XOM element MUST be set before the component is used.

History
None.

Nested Elements
Name Cardinality Availability None.

Attributes
Name Cardinality Availability ism:classification 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:ownerProducer 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

Validation Rules
Rule Type Applicability ism:classification must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:ownerProducer must exist. 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	AbstractSimpleString.Builder Abstract Builder for this DDMS component.

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSimpleString(nu.xom.Element element, boolean validateNow) Base constructor which works from a XOM element.
protected	AbstractSimpleString(String name, String value, SecurityAttributes attributes, boolean validateNow) Constructor which builds from raw data.
protected	AbstractSimpleString(String prefix, String namespace, String name, String value, SecurityAttributes attributes, boolean validateNow) Constructor which builds from raw data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
String	getValue() Accessor for the child text of the description.
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, getHTMLTextOutput, getJSONObject, 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

AbstractSimpleString

protected AbstractSimpleString(nu.xom.Element element,
                               boolean validateNow)
                        throws InvalidDDMSException

Base constructor which works from a XOM element.

Parameters:

element - the XOM element

validateNow - true if the component should be validated here

Throws:

InvalidDDMSException

AbstractSimpleString

protected AbstractSimpleString(String name,
                               String value,
                               SecurityAttributes attributes,
                               boolean validateNow)
                        throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

name - the name of the element without a prefix

value - the value of the element's child text

attributes - the security attributes

validateNow - true if the component should be validated here

Throws:

InvalidDDMSException

AbstractSimpleString

protected AbstractSimpleString(String prefix,
                               String namespace,
                               String name,
                               String value,
                               SecurityAttributes attributes,
                               boolean validateNow)
                        throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

prefix - the XML prefix

namespace - the namespace of the element

name - the name of the element without a prefix

value - the value of the element's child text

attributes - the security attributes

validateNow - true if the component should be validated here

Throws:

InvalidDDMSException

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

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

getValue

public String getValue()

Accessor for the child text of the description. The underlying XOM method which retrieves the child text returns an empty string if not found.

getSecurityAttributes

public SecurityAttributes getSecurityAttributes()

Accessor for the Security Attributes. Will always be non-null even if the attributes are not set.

Specified by:

getSecurityAttributes in interface IDDMSComponent

Overrides:

getSecurityAttributes in class AbstractBaseComponent