buri.ddmsence.ddms.summary

Class TemporalCoverage

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.summary.TemporalCoverage

All Implemented Interfaces:

IDDMSComponent

public final class TemporalCoverage
extends AbstractBaseComponent

An immutable implementation of ddms:temporalCoverage.

Before DDMS 4.0.1, a temporalCoverage element contains a locally defined TimePeriod construct. This TimePeriod construct is a container for the name, start, and end values of a time period. It exists only inside of a ddms:temporalCoverage parent, so it is not implemented as a Java object. Starting in DDMS 4.0.1, the TimePeriod wrapper has been removed.

Starting in DDMS 4.1, the start and end dates may optionally be replaced by an approximableStart or approximableEnd date.

To avoid confusion between the name of the temporalCoverage element and the name of the specified time period, the latter is referred to as the "time period name".

If not "Not Applicable" or "Unknown", date formats must adhere to one of the DDMS-allowed date formats.

Strictness
DDMSence allows the following legal, but nonsensical constructs: A time period name element can be used with no child text. A completely empty approximableStart or approximableEnd date can be used.

Nested Elements

ddms:name: An interval of time, which can be expressed as a named era (0-1 optional, default=Unknown). Zero or 1 of these elements may appear. ddms:start: The start date of a period of time (exactly 1 optional, default=Unknown). ddms:end: The end date of a period of time (exactly 1 optional, default=Unknown). ddms:approximableStart: The approximable start date (exactly 1 optional) ddms:approximableEnd: The approximable end date (exactly 1 optional)

Attributes
SecurityAttributes: The classification and ownerProducer attributes are optional. (starting in DDMS 3.0)

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
TemporalCoverage(nu.xom.Element element) Constructor for creating a component from a XOM Element
TemporalCoverage(String timePeriodName, ApproximableDate approximableStart, ApproximableDate approximableEnd, SecurityAttributes securityAttributes) Constructor for creating a component from raw data, using two approximable dates.
TemporalCoverage(String timePeriodName, ApproximableDate approximableStart, String endString, SecurityAttributes securityAttributes) Constructor for creating a component from raw data, using an approximable start date and an exact end date.
TemporalCoverage(String timePeriodName, String startString, ApproximableDate approximableEnd, SecurityAttributes securityAttributes) Constructor for creating a component from raw data, using an exact start date and an approximable end date.
TemporalCoverage(String timePeriodName, String startString, String endString, SecurityAttributes securityAttributes) Constructor for creating a component from raw data, using two exact date values.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
ApproximableDate	getApproximableEnd() Accessor for the approximableStart date.
ApproximableDate	getApproximableStart() Accessor for the approximableStart date.
javax.xml.datatype.XMLGregorianCalendar	getEnd() 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 getEndString() to access the raw XML format of the date, "Not Applicable", or "Unknown" values instead.
String	getEndString() Accessor for the end date as a string.
protected String	getLocatorSuffix() Can be overridden to change the locator string used in warnings and errors.
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.
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
javax.xml.datatype.XMLGregorianCalendar	getStart() 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 getStartString() to access the raw XML format of the date, "Not Applicable", or "Unknown" values instead.
String	getStartString() Accessor for the start date as a string.
String	getTimePeriodName() Accessor for the TimePeriod name element child text.
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, getName, getNamespace, getPrefix, getQualifiedName, 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

TemporalCoverage

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

TemporalCoverage

public TemporalCoverage(String timePeriodName,
                String startString,
                String endString,
                SecurityAttributes securityAttributes)
                 throws InvalidDDMSException

Constructor for creating a component from raw data, using two exact date values.

Parameters:

timePeriodName - the time period name (optional) (if empty, defaults to Unknown)

startString - a string representation of the date (required) (if empty, defaults to Unknown)

endString - a string representation of the end date (required) (if empty, defaults to Unknown)

securityAttributes - any security attributes (optional)

Throws:

InvalidDDMSException - if any required information is missing or malformed

TemporalCoverage

public TemporalCoverage(String timePeriodName,
                String startString,
                ApproximableDate approximableEnd,
                SecurityAttributes securityAttributes)
                 throws InvalidDDMSException

Constructor for creating a component from raw data, using an exact start date and an approximable end date.

Parameters:

timePeriodName - the time period name (optional) (if empty, defaults to Unknown)

startString - a string representation of the date (required) (if empty, defaults to Unknown)

approximableEnd - the end date, as an approximable date (required)

securityAttributes - any security attributes (optional)

Throws:

InvalidDDMSException - if any required information is missing or malformed

TemporalCoverage

public TemporalCoverage(String timePeriodName,
                ApproximableDate approximableStart,
                String endString,
                SecurityAttributes securityAttributes)
                 throws InvalidDDMSException

Constructor for creating a component from raw data, using an approximable start date and an exact end date.

Parameters:

timePeriodName - the time period name (optional) (if empty, defaults to Unknown)

approximableStart - the start date, as an approximable date (required)

endString - a string representation of the end date (required) (if empty, defaults to Unknown)

securityAttributes - any security attributes (optional)

Throws:

InvalidDDMSException - if any required information is missing or malformed

TemporalCoverage

public TemporalCoverage(String timePeriodName,
                ApproximableDate approximableStart,
                ApproximableDate approximableEnd,
                SecurityAttributes securityAttributes)
                 throws InvalidDDMSException

Constructor for creating a component from raw data, using two approximable dates.

Parameters:

timePeriodName - the time period name (optional) (if empty, defaults to Unknown)

approximableStart - the start date, as an approximable date (required)

approximableEnd - the end date, as an approximable date (required)

securityAttributes - any security attributes (optional)

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 start exists, it is a valid date format. If end exists, it is a valid date format. 0-1 names, start, end, approximableStart, approximableEnd exist. The SecurityAttributes do not exist until DDMS 3.0 or later. approximableStart and approximableEnd do not exist until DDMS 4.1 or later.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractBaseComponent.validate()

validateWarnings

protected void validateWarnings()

Validates any conditions that might result in a warning.

Rules
A ddms:name element was found with no value. A ddms:approximableStart or ddms:approximableEnd element may cause issues for DDMS 4.0 records.

Overrides:

validateWarnings in class AbstractBaseComponent

getLocatorSuffix

protected String getLocatorSuffix()

Description copied from class: AbstractBaseComponent

Can be overridden to change the locator string used in warnings and errors.

For components such as Format, there are wrapper elements that are not implemented as Java objects. These elements should be included in the XPath string used to identify the source of the error.

For example, if a ddms:extent element has a warning and the ddms:format element reports it, the locator information should be "/ddms:format/ddms:Media/ddms:extent" and not the default of "/ddms:format/ddms:extent"

Overrides:

getLocatorSuffix in class AbstractBaseComponent

Returns:

an empty string, unless overridden.

See Also:

AbstractBaseComponent.getLocatorSuffix()

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

getTimePeriodName

public String getTimePeriodName()

Accessor for the TimePeriod name element child text. Note that the getName() accessor will return the local name of the temporal coverage element (temporalCoverage).

getStart

public javax.xml.datatype.XMLGregorianCalendar getStart()

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 getStartString() to access the raw XML format of the date, "Not Applicable", or "Unknown" values instead.

Accessor for the XML calendar representing the start date

getStartString

public String getStartString()

Accessor for the start date as a string. If the value of start cannot be represented by an XML calendar, this will return "Not Applicable" or "Unknown". Use getStart to work with this value as a calendar date.

getEnd

public javax.xml.datatype.XMLGregorianCalendar getEnd()

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 getEndString() to access the raw XML format of the date, "Not Applicable", or "Unknown" values instead.

Accessor for the XML calendar representing the end date

getEndString

public String getEndString()

Accessor for the end date as a string. If the value of end cannot be represented by an XML calendar, this will return "Not Applicable" or "Unknown". Use getEnd to work with this value as a calendar date.

getApproximableStart

public ApproximableDate getApproximableStart()

Accessor for the approximableStart date.

getApproximableEnd

public ApproximableDate getApproximableEnd()

Accessor for the approximableStart date.

getSecurityAttributes

public SecurityAttributes getSecurityAttributes()

Accessor for the Security Attributes. Will always be non-null, even if it has no values set.

Specified by:

getSecurityAttributes in interface IDDMSComponent

Overrides:

getSecurityAttributes in class AbstractBaseComponent