buri.ddmsence.ddms.format

Class Extent

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractQualifierValue

buri.ddmsence.ddms.format.Extent

All Implemented Interfaces:

IDDMSComponent

public final class Extent
extends AbstractQualifierValue

An immutable implementation of ddms:extent.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
None.

Nested Elements
Name Cardinality Availability None.

Attributes
Name Cardinality Availability ddms:qualifier 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:value 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:qualifier must exist if ddms:value is set. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, the ddms:qualifier must be a valid URI. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 A ddms:qualifier can be set with no ddms:value. Warning 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 Note: The ddms:value is not validated against the qualifier's vocabulary.

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Extent(nu.xom.Element element) Constructor for creating a component from a XOM Element
Extent(String qualifier, String value) 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.
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
protected void	validate() Validates the component.
protected void	validateWarnings() Base case for warnings.

Methods inherited from class buri.ddmsence.AbstractQualifierValue

getQualifier, getQualifierName, getValue, getValueName, hashCode

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

Extent

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

Extent

public Extent(String qualifier,
      String value)
       throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

qualifier - the value of the qualifier attribute

value - the value of the value attribute

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

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 AbstractQualifierValue

See Also:

Object.equals(Object)

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