buri.ddmsence.ddms.resource

Class Unknown

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractRoleEntity

buri.ddmsence.ddms.resource.Unknown

All Implemented Interfaces:

IDDMSComponent, IRoleEntity

public final class Unknown
extends AbstractRoleEntity

An immutable implementation of a ddms:unknown element.

Strictness
DDMSence is stricter than the specification in the following ways: At least 1 name value must be non-empty. DDMSence allows the following legal, but nonsensical constructs: A phone number can be set with no value. An email can be set with no value.

The ddms:unknown element is new in DDMS 3.0. Attempts to use it with DDMS 2.0 will result in an UnsupportedVersionException. Its name was changed from "Unknown" to "unknown" in DDMS 4.0.1.

Nested Elements
ddms:name: names of the producer (1-many, at least 1 required) ddms:phone: phone numbers of the producer (0-many optional) ddms:email: email addresses of the producer (0-many optional)

Attributes
ExtensibleAttributes

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Unknown(nu.xom.Element element) Constructor for creating a component from a XOM Element
Unknown(List<String> names, List<String> phones, List<String> emails) Constructor for creating a component from raw data.
Unknown(List<String> names, List<String> phones, List<String> emails, ExtensibleAttributes extensions) 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
protected void	validate() Validates the component.

Methods inherited from class buri.ddmsence.AbstractRoleEntity

getEmails, getExtensibleAttributes, getNames, getOutput, getPhones, hashCode, validateWarnings

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, getStringAsDouble, getValidationWarnings, getXOMElement, getXOMElementCopy, requireVersion, setXOMElement, toHTML, toString, toText, toXML

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface buri.ddmsence.ddms.IDDMSComponent

getName, getNamespace, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElementCopy, toHTML, toText, toXML

Constructor Detail

Unknown

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

Unknown

public Unknown(List<String> names,
       List<String> phones,
       List<String> emails)
        throws InvalidDDMSException

Constructor for creating a component from raw data.

Parameters:

names - an ordered list of names

phones - an ordered list of phone numbers

emails - an ordered list of email addresses

Throws:

InvalidDDMSException

Unknown

public Unknown(List<String> names,
       List<String> phones,
       List<String> emails,
       ExtensibleAttributes extensions)
        throws InvalidDDMSException

Constructor for creating a component from raw data.

Parameters:

names - an ordered list of names

phones - an ordered list of phone numbers

emails - an ordered list of email addresses

extensions - extensible attributes (optional)

Throws:

InvalidDDMSException

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct. This component cannot be used until DDMS 3.0 or later.

Overrides:

validate in class AbstractRoleEntity

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractRoleEntity.validate()

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 AbstractRoleEntity

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