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.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
None.

Nested Elements
Name Cardinality Availability ddms:acquiredOn 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes
Name Cardinality Availability ddms:created 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:posted 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:validTil 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:infoCutOff 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:approvedOn 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:receivedOn 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules

Rule Type Applicability 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 ddms:approvedOn 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 ddms:receivedOn 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 ddms:acquiredOn 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 If set, each date attribute 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 ddms:acquiredOn may cause issues for DDMS 4.0.1 systems. Warning In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

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.

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

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

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() Accessor for the approved on date.
String	getApprovedOnString() Accessor for the approved on date.
javax.xml.datatype.XMLGregorianCalendar	getCreated() Accessor for the created date.
String	getCreatedString() Accessor for the created date.
String	getHTMLTextOutput(OutputFormat format, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
javax.xml.datatype.XMLGregorianCalendar	getInfoCutOff() Accessor for the cutoff date.
String	getInfoCutOffString() Accessor for the cutoff date.
com.google.gson.JsonObject	getJSONObject() Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.
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.
javax.xml.datatype.XMLGregorianCalendar	getPosted() Accessor for the posted date.
String	getPostedString() Accessor for the posted date.
javax.xml.datatype.XMLGregorianCalendar	getReceivedOn() Accessor for the received on date.
String	getReceivedOnString() Accessor for the received on date.
javax.xml.datatype.XMLGregorianCalendar	getValidTil() Accessor for the expiration date.
String	getValidTilString() Accessor for the expiration date.
int	hashCode() Returns a hashcode for the component.
protected void	validate() Base case for validation.
protected void	validateWarnings() Base case for warnings.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, 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

posted - the posting date

validTil - the expiration date

infoCutOff - the info cutoff date

approvedOn - the approved on date

receivedOn - the received on date

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

created - the creation date

posted - the posting date

validTil - the expiration date

infoCutOff - the info cutoff date

approvedOn - the approved on date

receivedOn - the received on date

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

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

getJSONObject

public com.google.gson.JsonObject getJSONObject()

Description copied from class: AbstractBaseComponent

Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object. Although this method is marked a public, it is only intended to be used internally, and is not part of the IDDMSComponent interface. Use the toJSON() method as the public way to get JSON output.

Specified by:

getJSONObject in class AbstractBaseComponent

See Also:

AbstractBaseComponent.getJSONObject()

getHTMLTextOutput

public String getHTMLTextOutput(OutputFormat format,
                                String prefix,
                                String suffix)

Description copied from class: AbstractBaseComponent

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

I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toHTML() and toText() as the formal, public methods to generate output.

Specified by:

getHTMLTextOutput in class AbstractBaseComponent

Parameters:

format - the desired format of this output

prefix - an optional prefix to put on each name.

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

Returns:

the representation of this component in the specified format

See Also:

AbstractBaseComponent.getHTMLTextOutput(OutputFormat, 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()

Accessor for the created date. Returns a copy.

DDMS 4.1 added a new allowable date format (ddms:DateHourMinType). This method will convert values of that type into an XMLGregorianCalendar, using intelligent defaults for any missing information (e.g. 00 for seconds). getCreatedString() will return the raw XML format without any assumptions.

getCreatedString

public String getCreatedString()

Accessor for the created date.

getPosted

public javax.xml.datatype.XMLGregorianCalendar getPosted()

Accessor for the posted date. Returns a copy.

DDMS 4.1 added a new allowable date format (ddms:DateHourMinType). This method will convert values of that type into an XMLGregorianCalendar, using intelligent defaults for any missing information (e.g. 00 for seconds). getPostedString() will return the raw XML format without any assumptions.

getPostedString

public String getPostedString()

Accessor for the posted date.

getValidTil

public javax.xml.datatype.XMLGregorianCalendar getValidTil()

Accessor for the expiration date. Returns a copy.

DDMS 4.1 added a new allowable date format (ddms:DateHourMinType). This method will convert values of that type into an XMLGregorianCalendar, using intelligent defaults for any missing information (e.g. 00 for seconds). getValidTilString() will return the raw XML format without any assumptions.

getValidTilString

public String getValidTilString()

Accessor for the expiration date.

getInfoCutOff

public javax.xml.datatype.XMLGregorianCalendar getInfoCutOff()

Accessor for the cutoff date. Returns a copy.

DDMS 4.1 added a new allowable date format (ddms:DateHourMinType). This method will convert values of that type into an XMLGregorianCalendar, using intelligent defaults for any missing information (e.g. 00 for seconds). getInfoCutOffString() will return the raw XML format without any assumptions.

getInfoCutOffString

public String getInfoCutOffString()

Accessor for the cutoff date.

getApprovedOn

public javax.xml.datatype.XMLGregorianCalendar getApprovedOn()

Accessor for the approved on date. Returns a copy.

DDMS 4.1 added a new allowable date format (ddms:DateHourMinType). This method will convert values of that type into an XMLGregorianCalendar, using intelligent defaults for any missing information (e.g. 00 for seconds). getApprovedOnString() will return the raw XML format without any assumptions.

getApprovedOnString

public String getApprovedOnString()

Accessor for the approved on date.

getReceivedOn

public javax.xml.datatype.XMLGregorianCalendar getReceivedOn()

Accessor for the received on date. Returns a copy.

DDMS 4.1 added a new allowable date format (ddms:DateHourMinType). This method will convert values of that type into an XMLGregorianCalendar, using intelligent defaults for any missing information (e.g. 00 for seconds). getReceivedOnString() will return the raw XML format without any assumptions.

getReceivedOnString

public String getReceivedOnString()

Accessor for the received on date.

getAcquiredOns

public List<ApproximableDate> getAcquiredOns()

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