buri.ddmsence.ddms.resource

Class Addressee

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractTaskingRole

buri.ddmsence.ddms.resource.Addressee

All Implemented Interfaces:

IDDMSComponent

public class Addressee
extends AbstractTaskingRole

An immutable implementation of ddms:addressee.

Nested Elements
ddms:organization: The organization who is the addressee (0-1, optional), implemented as an Organization ddms:person: the person who is the addressee (0-1, optional), implemented as a Person Only one of the nested entities can appear in an addressee element.

Attributes
SecurityAttributes: The classification and ownerProducer attributes are required.

Since:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Addressee(nu.xom.Element element) Constructor for creating a component from a XOM Element
Addressee(IRoleEntity entity, SecurityAttributes securityAttributes) Constructor which builds 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.AbstractTaskingRole

getEntity, getNestedComponents, getOutput, getSecurityAttributes

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getPrefix, getQualifiedName, getStringAsDouble, getValidationWarnings, getXOMElement, getXOMElementCopy, hashCode, requireVersion, setXOMElement, toHTML, toString, toText, toXML, validateWarnings

Methods inherited from class Object

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

Constructor Detail

Addressee

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

Addressee

public Addressee(IRoleEntity entity,
         SecurityAttributes securityAttributes)
          throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

entity - the actual entity who is the addressee (required)

securityAttributes - any security attributes (required)

Throws:

InvalidDDMSException

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct. Only 0-1 persons or organizations exist.

Overrides:

validate in class AbstractTaskingRole

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

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

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