ApproximableDate (DDMSence 2.2.1 API)

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.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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.

History
None.

Nested Elements

Name

Cardinality

Availability

ddms:description

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:approximableDate

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:searchableDate/ddms:start

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:searchableDate/ddms:end

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Attributes

Name

Cardinality

Availability

ddms:approximableDate/@ddms:approximation

0..1

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

The qualified name of this element must be correct.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If set, the ddms:approximableDate must adhere to a valid date format.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If set, the ddms:approximableDate/@ddms:approximation is a valid token.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If set, the ddms:searchableDate/ddms:start must adhere to a valid date format.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If set, the ddms:searchableDate/ddms:end must adhere to a valid date format.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

This component can be used with no values set.

Warning

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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.

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.
`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
`String`	`getSearchableStartString()` Accessor for the searchableStart date
`int`	`hashCode()` Returns a hashcode for the component.
`protected void`	`validate()` Base case for validation.
`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()` Base case for warnings.

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, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, 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
    approximableDate - the value of the approximable date
    approximation - an attribute that decorates the date
    searchableStartDate - the lower bound for this approximable date
    searchableEndDate - the upper bound for this approximable date
    
    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
```
    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()
  - validateWarnings
```
protected void validateWarnings()
```
    Description copied from class: AbstractBaseComponent
    
    Base case for warnings. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.
    
    Overrides:
    
    validateWarnings in class AbstractBaseComponent
    
    See Also:
    AbstractBaseComponent.validateWarnings()
  - 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.
  - getApproximation
```
public String getApproximation()
```
    Accessor for the value of the approximation attribute
  - getSearchableStartString
```
public String getSearchableStartString()
```
    Accessor for the searchableStart date
  - getSearchableEndString
```
public String getSearchableEndString()
```
    Accessor for the searchableEnd date

Class ApproximableDate

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

ApproximableDate

ApproximableDate

Method Detail

validateApproximation

validateElementName

validate

validateWarnings

getOutput

equals

hashCode

getDescription

getApproximableDateString

getApproximation

getSearchableStartString

getSearchableEndString