buri.ddmsence

Class AbstractProducerRole

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractProducerRole

All Implemented Interfaces:

IDDMSComponent

Direct Known Subclasses:

Contributor, Creator, PointOfContact, Publisher

public abstract class AbstractProducerRole
extends AbstractBaseComponent

Base class for DDMS producer elements, such as ddms:creator and ddms:contributor.

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:organization 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:person 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:service 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:unknown 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes
Name Cardinality Availability ism:pocType 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:<securityAttributes> 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules
Rule Type Applicability Exactly 1 producer entity must fill this role. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:pocType must not be used before the DDMS version in which it was introduced. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, ism:pocType contains valid tokens. 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	AbstractProducerRole.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	AbstractProducerRole(nu.xom.Element element) Base constructor
protected	AbstractProducerRole(String producerType, IRoleEntity entity, List<String> pocTypes, SecurityAttributes securityAttributes) Constructor which builds from raw data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
IRoleEntity	getEntity() Accessor for the entity fulfilling this producer role
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.
protected List<IDDMSComponent>	getNestedComponents() Accessor for a collection of nested components.
List<String>	getPocTypes() Accessor for the pocType attribute.
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
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, getPrefix, getQualifiedName, 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

Constructor Detail

AbstractProducerRole

protected AbstractProducerRole(nu.xom.Element element)
                        throws InvalidDDMSException

Base constructor

Parameters:

element - the XOM element representing this component

Throws:

InvalidDDMSException

AbstractProducerRole

protected AbstractProducerRole(String producerType,
                               IRoleEntity entity,
                               List<String> pocTypes,
                               SecurityAttributes securityAttributes)
                        throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

producerType - the type of producer this producer entity is fulfilling (i.e. creator or contributor)

entity - the actual entity fulfilling this role

pocTypes - the pocType attribute

securityAttributes - any security 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)

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

getEntity

public IRoleEntity getEntity()

Accessor for the entity fulfilling this producer role

getPocTypes

public List<String> getPocTypes()

Accessor for the pocType attribute.

getSecurityAttributes

public SecurityAttributes getSecurityAttributes()

Accessor for the Security Attributes. Will always be non-null even if the attributes are not set.

Specified by:

getSecurityAttributes in interface IDDMSComponent

Overrides:

getSecurityAttributes in class AbstractBaseComponent