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.

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

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

Modifier and Type	Field and Description
protected static String	QUALIFIER_NAME
protected static String	VALUE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractQualifierValue() This implicit superconstructor does nothing.
protected	AbstractQualifierValue(nu.xom.Element element) Base constructor
protected	AbstractQualifierValue(String name, String qualifier, String value, 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	getQualifier() Accessor for the value of the qualifier attribute
String	getValue() Accessor for the value of the value attribute
int	hashCode() Returns a hashcode for the component.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getNestedComponents, getOutput, getPrefix, getQualifiedName, getSecurityAttributes, getStringAsDouble, getValidationWarnings, getXOMElement, getXOMElementCopy, requireVersion, setXOMElement, toHTML, toString, toText, toXML, validate, validateWarnings

Methods inherited from class Object

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

Field Detail

QUALIFIER_NAME

protected static final String QUALIFIER_NAME

See Also:

Constant Field Values

VALUE_NAME

protected static final String VALUE_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractQualifierValue

protected AbstractQualifierValue()
                          throws InvalidDDMSException

This implicit superconstructor does nothing.

Throws:

InvalidDDMSException

AbstractQualifierValue

protected AbstractQualifierValue(nu.xom.Element element)
                          throws InvalidDDMSException

Base constructor

Parameters:

element - the XOM element representing this component

Throws:

InvalidDDMSException

AbstractQualifierValue

protected AbstractQualifierValue(String name,
                      String qualifier,
                      String value,
                      boolean validateNow)
                          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.

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

getQualifier

public String getQualifier()

Accessor for the value of the qualifier attribute

getValue

public String getValue()

Accessor for the value of the value attribute