buri.ddmsence.ddms.resource

Class RecordKeeper

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.resource.RecordKeeper

All Implemented Interfaces:

IDDMSComponent

public class RecordKeeper
extends AbstractBaseComponent

An immutable implementation of ddms:recordKeeper.

Strictness
DDMSence is stricter than the specification in the following ways: The recordKeeperID must not be empty.

Nested Elements
ddms:recordKeeperID: A unique identifier for the Record Keeper (exactly 1 required) ddms:organization: The organization which acts as the record keeper (exactly 1 required), implemented as an Organization

Since:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RecordKeeper(nu.xom.Element element) Constructor for creating a component from a XOM Element
RecordKeeper(String recordKeeperID, Organization organization) 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 List<IDDMSComponent>	getNestedComponents() Accessor for a collection of nested components.
Organization	getOrganization() Accessor for the organization
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
String	getRecordKeeperID() Accessor for the recordKeeperID
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.

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, validateWarnings

Methods inherited from class Object

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

Constructor Detail

RecordKeeper

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

RecordKeeper

public RecordKeeper(String recordKeeperID,
            Organization organization)
             throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

recordKeeperID - a unique ID for the organization (required)

organization - the organization acting as record keeper (required)

Throws:

InvalidDDMSException

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct. The recordKeeperID exists. The organization exists. Exactly 1 organization exists. This component cannot exist until DDMS 4.0.1 or later.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

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

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.

Specified by:

getOutput in class AbstractBaseComponent

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

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

getRecordKeeperID

public String getRecordKeeperID()

Accessor for the recordKeeperID

getOrganization

public Organization getOrganization()

Accessor for the organization