buri.ddmsence

Class AbstractNtkString

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractNtkString

All Implemented Interfaces:

IDDMSComponent

Direct Known Subclasses:

GroupValue, IndividualValue, ProfileValue, SystemName

public abstract class AbstractNtkString
extends AbstractBaseComponent

Base class for NTK elements which consist of simple child text decorated with NTK attributes, and security attributes.

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
This abstract class was introduced to support NTK Access components in DDMS 4.1. Those components are no longer a part of DDMS 5.0.

Nested Elements
Name Cardinality Availability None.

Attributes
Name Cardinality Availability ntk:id 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 nkt:IDReference 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 nkt:qualifier 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 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 Component must not be used before the DDMS version in which it was introduced. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If this is an NMTOKEN-based string, and the child text is not empty, the child text is an NMTOKEN. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 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:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractNtkString.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	AbstractNtkString(boolean tokenBased, nu.xom.Element element) Base constructor which works from a XOM element.
protected	AbstractNtkString(boolean tokenBased, String name, String value, String id, String idReference, String qualifier, SecurityAttributes securityAttributes, boolean validateNow) Constructor which builds from raw data.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getID() Accessor for the ID
String	getIDReference() Accessor for the IDReference
String	getQualifier() Accessor for the qualifier
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

AbstractNtkString

protected AbstractNtkString(boolean tokenBased,
                 nu.xom.Element element)
                     throws InvalidDDMSException

Base constructor which works from a XOM element.

Parameters:

tokenBased - true if the child text is an NMTOKEN, false if it's just a string

element - the XOM element

Throws:

InvalidDDMSException

AbstractNtkString

protected AbstractNtkString(boolean tokenBased,
                 String name,
                 String value,
                 String id,
                 String idReference,
                 String qualifier,
                 SecurityAttributes securityAttributes,
                 boolean validateNow)
                     throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

tokenBased - true if the child text is an NMTOKEN, false if it's just a string

name - the name of the element without a prefix

value - the value of the element's child text

id - the NTK ID

idReference - a reference to an NTK ID

qualifier - an NTK qualifier

securityAttributes - the security attributes

validateNow - whether to validate immediately

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.

getID

public String getID()

Accessor for the ID

getIDReference

public String getIDReference()

Accessor for the IDReference

getQualifier

public String getQualifier()

Accessor for the qualifier

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