buri.ddmsence.ddms.resource

Class Creator

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractProducerRole

buri.ddmsence.ddms.resource.Creator

All Implemented Interfaces:

IDDMSComponent

public class Creator
extends AbstractProducerRole

An immutable implementation of ddms:creator.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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:<securityAttributes> 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules
Rule Type Applicability The qualified name of this element must be correct. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 Exactly 1 producer entity must fill this role. 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	Creator.Builder Builder for this DDMS component.

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
Creator(nu.xom.Element element) Constructor for creating a component from a XOM Element
Creator(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.
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
protected void	validate() Base case for validation.

Methods inherited from class buri.ddmsence.AbstractProducerRole

getEntity, getHTMLTextOutput, getJSONObject, getNestedComponents, getPocTypes, getSecurityAttributes, hashCode

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

Creator

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

Creator

public Creator(IRoleEntity entity,
               List<String> pocTypes,
               SecurityAttributes securityAttributes)
        throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

entity - the actual entity fulfilling this role

pocTypes - the ISM pocType for this producer

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 AbstractProducerRole

Throws:

InvalidDDMSException

See Also:

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

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