buri.ddmsence.ddms

Class ApproximableDate

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.ApproximableDate

All Implemented Interfaces:

IDDMSComponent

public final class ApproximableDate
extends AbstractBaseComponent

Base class for DDMS elements which are an approximable date, such as ddms:dates/ddms:acquiredOn.

The structure of this class diverges from the usual DDMSence approach of selecting which DDMS components are implemented as Java classes. The ApproximableDateType, introduced in DDMS 4.1, is directly reused in three locations in the DDMS schema, so it is implemented as a final class rather than an Abstract class. It contains one wrapper element, ddms:searchableDate, which is not implemented as a Java class.

This type also contains one element, ddms:approximableDate, which should be implemented as a Java class, since it contains an attribute. To simplify the class structure, this element and its attribute are collapsed into this Java class.

Strictness
DDMSence allows the following legal, but nonsensical constructs: This component can be used with no description, approximableDate, or searchableDate values. A ddms:description element can be used without child text.

Nested Elements

ddms:description: A description of this date (0-1, optional) ddms:approximableDate: The value of this date, associated with an optional approximation decorator (0-1, optional) ddms:searchableDate/ddms:start: The exact date which is the lower bound for this approximable date in searches (0-1, optional) ddms:searchableDate/ddms:end: The exact date which is the upper bound for this approximable date in searches (0-1, optional)

Attributes
ddms:approximableDate/ddms:approximation: An attribute that decorates the approximableDate with terms such as "early" or "late" (0-1, optional)

Since:

2.1.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ApproximableDate(nu.xom.Element element) Constructor for creating a component from a XOM Element
ApproximableDate(String name, String description, String approximableDate, String approximation, String searchableStartDate, String searchableEndDate) Constructor for creating a component from raw data

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getApproximableDateString() Accessor for the approximableDate (optional).
String	getApproximation() Accessor for the value of the approximation attribute
String	getDescription() Accessor for the description.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
String	getSearchableEndString() Accessor for the searchableEnd date (optional)
String	getSearchableStartString() Accessor for the searchableStart date (optional)
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.
static void	validateApproximation(String approximation) Validates an approximation against the allowed values.
static void	validateElementName(String name) Validates an element name against the allowed values.
protected void	validateWarnings() Validates any conditions that might result in a warning.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

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

Methods inherited from class Object

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

Constructor Detail

ApproximableDate

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

ApproximableDate

public ApproximableDate(String name,
                String description,
                String approximableDate,
                String approximation,
                String searchableStartDate,
                String searchableEndDate)
                 throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

name - the name of the element

description - the description of this approximable date (optional)

approximableDate - the value of the approximable date (optional)

approximation - an attribute that decorates the date (optional)

searchableStartDate - the lower bound for this approximable date (optional)

searchableEndDate - the upper bound for this approximable date (optional)

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validateApproximation

public static void validateApproximation(String approximation)
                                  throws InvalidDDMSException

Validates an approximation against the allowed values.

Parameters:

approximation - the value to test

Throws:

InvalidDDMSException - if the value is null, empty or invalid.

validateElementName

public static void validateElementName(String name)
                                throws InvalidDDMSException

Validates an element name against the allowed values.

Parameters:

name - the value to test

Throws:

InvalidDDMSException - if the value is null, empty or invalid.

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The name of the element has an appropriate value. If the approximableDate exists, it is an acceptable date format. If an approximation exists, it has an appropriate value. If start exists, it is a valid date format. If end exists, it is a valid date format. This component cannot be used until DDMS 4.1 or later.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException

See Also:

AbstractBaseComponent.validate()

validateWarnings

protected void validateWarnings()

Validates any conditions that might result in a warning.

Rules
A completely empty element was found. A description element can be used without any child text.

Overrides:

validateWarnings in class AbstractBaseComponent

getOutput

public String getOutput(boolean isHTML,
               String prefix,
               String suffix)

Description copied from class: AbstractBaseComponent

Renders this component as HTML or Text, with an optional prefix to nest it.

Specified by:

getOutput in class AbstractBaseComponent

Parameters:

isHTML - true for HTML, false for Text.

prefix - an optional prefix to put on each name.

suffix - an optional suffix to append to each name, such as an index.

Returns:

the HTML or Text representation of this component

See Also:

AbstractBaseComponent.getOutput(boolean, 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()

getDescription

public String getDescription()

Accessor for the description.

getApproximableDateString

public String getApproximableDateString()

Accessor for the approximableDate (optional).

getApproximation

public String getApproximation()

Accessor for the value of the approximation attribute

getSearchableStartString

public String getSearchableStartString()

Accessor for the searchableStart date (optional)

getSearchableEndString

public String getSearchableEndString()

Accessor for the searchableEnd date (optional)