buri.ddmsence.ddms.resource

Class Dates

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.resource.Dates

All Implemented Interfaces:

IDDMSComponent

public final class Dates
extends AbstractBaseComponent

An immutable implementation of ddms:dates.

Strictness
DDMSence allows the following legal, but nonsensical constructs: A dates element can be used with none of the seven date values set.

Nested Elements
ddms:acquiredOn: the acquisition date (0-many, starting in DDMS 4.1), implemented as an ApproximableDate

Attributes
ddms:created: creation date (optional) ddms:posted: posting date (optional) ddms:validTil: expiration date (optional) ddms:infoCutOff: info cutoff date (optional) ddms:approvedOn: approved for posting date (optional, starting in DDMS 3.1) ddms:receivedOn: received date (optional, starting in DDMS 4.0.1)

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Dates(nu.xom.Element element) Constructor for creating a component from a XOM Element
Dates(List<ApproximableDate> acquiredOns, String created, String posted, String validTil, String infoCutOff, String approvedOn, String receivedOn) Constructor for creating a component from raw data.
Dates(String created, String posted, String validTil, String infoCutOff, String approvedOn, String receivedOn) Deprecated. A new constructor was added for DDMS 4.1 to support ddms:acquiredOn. This constructor is preserved for backwards compatibility, but may disappear in the next major release.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
List<ApproximableDate>	getAcquiredOns() Accessor for the acquiredOn dates (0-many optional).
javax.xml.datatype.XMLGregorianCalendar	getApprovedOn() Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getApprovedOnString() to access the raw XML format of the date instead.
String	getApprovedOnString() Accessor for the approved on date (optional).
javax.xml.datatype.XMLGregorianCalendar	getCreated() Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getCreatedString() to access the raw XML format of the date instead.
String	getCreatedString() Accessor for the created date (optional).
javax.xml.datatype.XMLGregorianCalendar	getInfoCutOff() Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getInfoCutOffString() to access the raw XML format of the date instead.
String	getInfoCutOffString() Accessor for the cutoff date (optional).
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
protected List<IDDMSComponent>	getNestedComponents() Accessor for a collection of nested components.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
javax.xml.datatype.XMLGregorianCalendar	getPosted() Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getPostedString() to access the raw XML format of the date instead.
String	getPostedString() Accessor for the posted date (optional).
javax.xml.datatype.XMLGregorianCalendar	getReceivedOn() Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getReceivedOnString() to access the raw XML format of the date instead.
String	getReceivedOnString() Accessor for the received on date (optional).
javax.xml.datatype.XMLGregorianCalendar	getValidTil() Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getValidTilString() to access the raw XML format of the date instead.
String	getValidTilString() Accessor for the expiration date (optional).
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.
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, 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

Dates

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

Dates

public Dates(String created,
     String posted,
     String validTil,
     String infoCutOff,
     String approvedOn,
     String receivedOn)
      throws InvalidDDMSException

Deprecated. A new constructor was added for DDMS 4.1 to support ddms:acquiredOn. This constructor is preserved for backwards compatibility, but may disappear in the next major release.

Constructor for creating a component from raw data.

Parameters:

created - the creation date (optional)

posted - the posting date (optional)

validTil - the expiration date (optional)

infoCutOff - the info cutoff date (optional)

approvedOn - the approved on date (optional, starting in DDMS 3.1)

receivedOn - the received on date (optional, starting in DDMS 4.0.1)

Throws:

InvalidDDMSException - if any required information is missing or malformed

Dates

public Dates(List<ApproximableDate> acquiredOns,
     String created,
     String posted,
     String validTil,
     String infoCutOff,
     String approvedOn,
     String receivedOn)
      throws InvalidDDMSException

Constructor for creating a component from raw data.

Parameters:

acquiredOns - the acquisition dates (optional, starting in DDMS 4.1)

created - the creation date (optional)

posted - the posting date (optional)

validTil - the expiration date (optional)

infoCutOff - the info cutoff date (optional)

approvedOn - the approved on date (optional, starting in DDMS 3.1)

receivedOn - the received on date (optional, starting in DDMS 4.0.1)

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct. If set, each date attribute adheres to an acceptable date format. The approvedOn date cannot be used until DDMS 3.1 or later. The receivedOn date cannot be used until DDMS 4.0.1 or later. An acquiredOn date 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 ddms:dates element was found. A ddms:acquiredOn element may cause issues for DDMS 4.0 records.

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)

getNestedComponents

protected List<IDDMSComponent> getNestedComponents()

Description copied from class: AbstractBaseComponent

Accessor for a collection of nested components. A list such as this is useful for bulk actions, such as checking emptiness, equality, generating hash codes, or applying mass validation.

Overrides:

getNestedComponents in class AbstractBaseComponent

See Also:

AbstractBaseComponent.getNestedComponents()

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

getName

public static String getName(DDMSVersion version)

Accessor for the element name of this component, based on the version of DDMS used

Parameters:

version - the DDMSVersion

Returns:

an element name

getCreated

public javax.xml.datatype.XMLGregorianCalendar getCreated()

Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getCreatedString() to access the raw XML format of the date instead.

Accessor for the created date (optional). Returns a copy.

getCreatedString

public String getCreatedString()

Accessor for the created date (optional).

getPosted

public javax.xml.datatype.XMLGregorianCalendar getPosted()

Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getPostedString() to access the raw XML format of the date instead.

Accessor for the posted date (optional). Returns a copy.

getPostedString

public String getPostedString()

Accessor for the posted date (optional).

getValidTil

public javax.xml.datatype.XMLGregorianCalendar getValidTil()

Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getValidTilString() to access the raw XML format of the date instead.

Accessor for the expiration date (optional). Returns a copy.

getValidTilString

public String getValidTilString()

Accessor for the expiration date (optional).

getInfoCutOff

public javax.xml.datatype.XMLGregorianCalendar getInfoCutOff()

Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getInfoCutOffString() to access the raw XML format of the date instead.

Accessor for the cutoff date (optional). Returns a copy.

getInfoCutOffString

public String getInfoCutOffString()

Accessor for the cutoff date (optional).

getApprovedOn

public javax.xml.datatype.XMLGregorianCalendar getApprovedOn()

Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getApprovedOnString() to access the raw XML format of the date instead.

Accessor for the approved on date (optional). Returns a copy.

getApprovedOnString

public String getApprovedOnString()

Accessor for the approved on date (optional).

getReceivedOn

public javax.xml.datatype.XMLGregorianCalendar getReceivedOn()

Deprecated. Because DDMS 4.1 added a new allowable date format (ddms:DateHourMinType), XMLGregorianCalendar is no longer a sufficient representation. This accessor will return null for dates in the new format. Use getReceivedOnString() to access the raw XML format of the date instead.

Accessor for the received on date (optional). Returns a copy.

getReceivedOnString

public String getReceivedOnString()

Accessor for the received on date (optional).

getAcquiredOns

public List<ApproximableDate> getAcquiredOns()

Accessor for the acquiredOn dates (0-many optional).