buri.ddmsence

Class AbstractQualifierValue

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractQualifierValue

All Implemented Interfaces:

IDDMSComponent

Direct Known Subclasses:

CountryCode, Extent, Identifier, Language, RelatedResource, Source, SubDivisionCode, Type

public abstract class AbstractQualifierValue
extends AbstractBaseComponent

Base class for DDMS elements which have a qualifier/value attribute, such as ddms:Identifier and ddms:source.

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
In DDMS 5.0, CountryCode and SubDivisionCode have different attribute names (codespace instead of qualifier, and code instead of value). This class was updated to allow either pairing of attribute names. while maintaining the same accessor names.

Nested Elements
Name Cardinality Availability None.

Attributes
Name Cardinality Availability ddms:qualifier 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:value 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:codespace 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:code 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules
Rule Type Applicability No rules are validated at this level. Extending classes may have additional rules.

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractQualifierValue.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	AbstractQualifierValue() This implicit superconstructor does nothing.
protected	AbstractQualifierValue(nu.xom.Element element, boolean useClassicAttributeNames) Base constructor
protected	AbstractQualifierValue(String name, String qualifier, String value, boolean validateNow, boolean useClassicAttributeNames) Constructor which builds from raw data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getQualifier() Accessor for the value of the qualifier attribute (referred to in some DDMS 5.0 components as a "codespace")
String	getQualifierName() Accessor for the name of the qualifier attribute
String	getValue() Accessor for the value of the value attribute (referred to in some DDMS 5.0 components as a "code")
String	getValueName() Accessor for the name of the value attribute
int	hashCode() Returns a hashcode for the component.

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, getSecurityAttributes, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML, validate, validateWarnings

Methods inherited from class Object

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

Constructor Detail

AbstractQualifierValue

protected AbstractQualifierValue()
                          throws InvalidDDMSException

This implicit superconstructor does nothing.

Throws:

InvalidDDMSException

AbstractQualifierValue

protected AbstractQualifierValue(nu.xom.Element element,
                                 boolean useClassicAttributeNames)
                          throws InvalidDDMSException

Base constructor

Parameters:

element - the XOM element representing this component

useClassicAttributeNames - true for "qualifier/value" and false for "codespace/code".

Throws:

InvalidDDMSException

AbstractQualifierValue

protected AbstractQualifierValue(String name,
                                 String qualifier,
                                 String value,
                                 boolean validateNow,
                                 boolean useClassicAttributeNames)
                          throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

name - the name of the element without a prefix

qualifier - the value of the qualifier attribute

value - the value of the value attribute

validateNow - true to validate the component immediately. Because Source entities have additional fields they should not be validated in the superconstructor.

useClassicAttributeNames - true for "qualifier/value" and false for "codespace/code".

Throws:

InvalidDDMSException

Method Detail

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

getQualifierName

public String getQualifierName()

Accessor for the name of the qualifier attribute

getValueName

public String getValueName()

Accessor for the name of the value attribute

getQualifier

public String getQualifier()

Accessor for the value of the qualifier attribute (referred to in some DDMS 5.0 components as a "codespace")

getValue

public String getValue()

Accessor for the value of the value attribute (referred to in some DDMS 5.0 components as a "code")