buri.ddmsence.ddms.resource

Class Organization

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractRoleEntity

buri.ddmsence.ddms.resource.Organization

All Implemented Interfaces:

IDDMSComponent, IRoleEntity

public final class Organization
extends AbstractRoleEntity

An immutable implementation of ddms:organization.

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. An acronym can be set with no value.

The name of this component was changed from "Organization" to "organization" in DDMS 4.0.1.

Nested Elements
ddms:name: names of the producer entity (1-many, at least 1 required) ddms:phone: phone numbers of the producer entity (0-many optional) ddms:email: email addresses of the producer entity (0-many optional) ddms:subOrganization: suborganization (0-many optional, starting in DDMS 4.0.1), implemented as a SubOrganization

Attributes
ddms:acronym: an acronym for the organization (optional, starting in DDMS 4.0.1) ExtensibleAttributes

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Organization(nu.xom.Element element) Constructor for creating a component from a XOM Element
Organization(List<String> names, List<String> phones, List<String> emails, List<SubOrganization> subOrganizations, String acronym) Constructor for creating a component from raw data.
Organization(List<String> names, List<String> phones, List<String> emails, List<SubOrganization> subOrganizations, String acronym, 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.
String	getAcronym() Accessor for the acronym
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.
List<SubOrganization>	getSubOrganizations() Accessor for the suborganizations (0-many)
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.AbstractRoleEntity

getEmails, getExtensibleAttributes, getNames, getPhones

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, 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

Organization

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

Organization

public Organization(List<String> names,
            List<String> phones,
            List<String> emails,
            List<SubOrganization> subOrganizations,
            String acronym)
             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

subOrganizations - an ordered list of suborganizations

acronym - the organization's acronym

Throws:

InvalidDDMSException

Organization

public Organization(List<String> names,
            List<String> phones,
            List<String> emails,
            List<SubOrganization> subOrganizations,
            String acronym,
            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

subOrganizations - an ordered list of suborganizations

acronym - the organization's acronym

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. Acronyms cannot exist until DDMS 4.0.1 or later.

Overrides:

validate in class AbstractRoleEntity

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractRoleEntity.validate()

validateWarnings

protected void validateWarnings()

Validates any conditions that might result in a warning.

Rules
A ddms:acronym attribute was found with no value.

Overrides:

validateWarnings in class AbstractRoleEntity

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.

Overrides:

getOutput in class AbstractRoleEntity

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 AbstractRoleEntity

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 AbstractRoleEntity

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

getSubOrganizations

public List<SubOrganization> getSubOrganizations()

Accessor for the suborganizations (0-many)

getAcronym

public String getAcronym()

Accessor for the acronym