buri.ddmsence

Class AbstractRoleEntity

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractRoleEntity

All Implemented Interfaces:

IDDMSComponent, IRoleEntity

Direct Known Subclasses:

Organization, Person, Service, Unknown

public abstract class AbstractRoleEntity
extends AbstractBaseComponent
implements IRoleEntity

Base class for entities which fulfill some role, such as ddms:person and ddms:organization.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Extensions of this class are generally expected to be immutable, and the underlying XOM element MUST be set before the component is used.

History
None.

Nested Elements
Name Cardinality Availability ddms:name 1..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:phone 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:email 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes
Name Cardinality Availability any:<extensibleAttributes> 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules
Rule Type Applicability At least 1 ddms:name must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Since:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRoleEntity(nu.xom.Element element, boolean validateNow) Base constructor
protected	AbstractRoleEntity(String entityName, List<String> names, List<String> phones, List<String> emails, ExtensibleAttributes extensibleAttributes) Constructor which builds from raw data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
List<String>	getEmails() Accessor for the emails of the entity (0 to many).
ExtensibleAttributes	getExtensibleAttributes() Accessor for the extensible attributes.
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.
List<String>	getNames() Accessor for the names of the entity (1 to many).
List<String>	getPhones() Accessor for the phone numbers of the entity (0 to many).
int	hashCode() Returns a hashcode for the component.
protected void	validate() Base case for validation.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getNestedComponents, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML, validateWarnings

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, toJSON, toText, toXML

Constructor Detail

AbstractRoleEntity

protected AbstractRoleEntity(nu.xom.Element element,
                             boolean validateNow)
                      throws InvalidDDMSException

Base constructor

Parameters:

element - the XOM element representing this component

validateNow - true to validate the component immediately. Because Person and Organization entities have additional fields they should not be validated in the superconstructor.

Throws:

InvalidDDMSException

AbstractRoleEntity

protected AbstractRoleEntity(String entityName,
                             List<String> names,
                             List<String> phones,
                             List<String> emails,
                             ExtensibleAttributes extensibleAttributes)
                      throws InvalidDDMSException

Constructor which builds from raw data. Does not validate.

Parameters:

entityName - the element name of this entity (i.e. organization, person)

names - an ordered list of names

phones - an ordered list of phone numbers

emails - an ordered list of email addresses

extensibleAttributes - extensible attributes

Throws:

InvalidDDMSException

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()

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()

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)

getNames

public List<String> getNames()

Accessor for the names of the entity (1 to many).

Specified by:

getNames in interface IRoleEntity

Returns:

unmodifiable List

getPhones

public List<String> getPhones()

Accessor for the phone numbers of the entity (0 to many).

Specified by:

getPhones in interface IRoleEntity

Returns:

unmodifiable List

getEmails

public List<String> getEmails()

Accessor for the emails of the entity (0 to many).

Specified by:

getEmails in interface IRoleEntity

Returns:

unmodifiable List

getExtensibleAttributes

public ExtensibleAttributes getExtensibleAttributes()

Accessor for the extensible attributes. Will always be non-null, even if not set.

Specified by:

getExtensibleAttributes in interface IRoleEntity

Returns:

the attributes