TemporalCoverage (DDMSence 2.3.0 API)

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.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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.

History
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.

History

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.

Nested Elements

Name

Cardinality

Availability

ddms:name

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:start

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:end

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:approximableStart

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:approximableEnd

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Attributes

Name

Cardinality

Availability

ism:<securityAttributes>

0..*

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

If set, 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, 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

Approximable dates must not be used before the DDMS version in which they were introduced.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Security attributes must not be used before the DDMS version in which they were introduced.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

An empty ddms:name will be given a default value.

Warning

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Approximable dates 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 TemporalCoverage.Builder
Builder for this DDMS component.

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

Field Summary
- Fields inherited from class buri.ddmsence.AbstractBaseComponent
  OUTPUT_TEMPLATES

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.
`String`	`getHTMLTextOutput(OutputFormat format, String prefix, String suffix)` Renders this component as HTML or Text, with an optional prefix to nest it.
`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.
`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.
`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()` 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, getName, getNamespace, getPrefix, getQualifiedName, 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
  - 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
    startString - a string representation of the date
    endString - a string representation of the end date
    securityAttributes - any security attributes
    
    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
    startString - a string representation of the date
    approximableEnd - the end date, as an approximable date
    securityAttributes - any security attributes
    
    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
    approximableStart - the start date, as an approximable date
    endString - a string representation of the end date
    securityAttributes - any security attributes
    
    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 (if empty, defaults to Unknown)
    approximableStart - the start date, as an approximable date
    approximableEnd - the end date, as an approximable date
    securityAttributes - any security attributes
    
    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()
  - 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()
  - 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
  - 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

Class TemporalCoverage

Nested Class Summary

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

TemporalCoverage

TemporalCoverage

TemporalCoverage

TemporalCoverage

TemporalCoverage

Method Detail

validate

validateWarnings

getLocatorSuffix

getJSONObject

getHTMLTextOutput

getNestedComponents

equals

hashCode

getName

getTimePeriodName

getStart

getStartString

getEnd

getEndString

getApproximableStart

getApproximableEnd

getSecurityAttributes